Fix rustdoc errors in components/script/dom (#31617)

* Fix rustdoc errors in components/script/dom

* Revert if to iff in audiobuffer.rs
This commit is contained in:
Mucha Naibei 2024-03-12 01:04:05 +03:00 committed by GitHub
parent 45344dca2b
commit d1fd8d55ab
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 4 additions and 4 deletions

View file

@ -44,7 +44,7 @@ pub struct AudioBuffer {
#[ignore_malloc_size_of = "mozjs"] #[ignore_malloc_size_of = "mozjs"]
js_channels: DomRefCell<Vec<HeapBufferSource<Float32>>>, js_channels: DomRefCell<Vec<HeapBufferSource<Float32>>>,
/// Aggregates the data from js_channels. /// Aggregates the data from js_channels.
/// This is Some<T> iff the buffers in js_channels are detached. /// This is `Some<T>` iff the buffers in js_channels are detached.
#[ignore_malloc_size_of = "servo_media"] #[ignore_malloc_size_of = "servo_media"]
#[no_trace] #[no_trace]
shared_channels: DomRefCell<Option<ServoMediaAudioBuffer>>, shared_channels: DomRefCell<Option<ServoMediaAudioBuffer>>,

View file

@ -68,7 +68,7 @@ impl TrustedReference {
/// A safe wrapper around a DOM Promise object that can be shared among threads for use /// A safe wrapper around a DOM Promise object that can be shared among threads for use
/// in asynchronous operations. The underlying DOM object is guaranteed to live at least /// in asynchronous operations. The underlying DOM object is guaranteed to live at least
/// as long as the last outstanding `TrustedPromise` instance. These values cannot be cloned, /// as long as the last outstanding `TrustedPromise` instance. These values cannot be cloned,
/// only created from existing Rc<Promise> values. /// only created from existing `Rc<Promise>` values.
pub struct TrustedPromise { pub struct TrustedPromise {
dom_object: *const Promise, dom_object: *const Promise,
owner_thread: *const libc::c_void, owner_thread: *const libc::c_void,

View file

@ -135,7 +135,7 @@ pub trait DomObjectWrap: Sized + DomObject {
/// A trait to provide a function pointer to wrap function for /// A trait to provide a function pointer to wrap function for
/// DOM iterator interfaces. /// DOM iterator interfaces.
pub trait DomObjectIteratorWrap: DomObjectWrap + JSTraceable + Iterable { pub trait DomObjectIteratorWrap: DomObjectWrap + JSTraceable + Iterable {
/// Function pointer to the wrap function for IterableIterator<T> /// Function pointer to the wrap function for `IterableIterator<T>`
const ITER_WRAP: unsafe fn( const ITER_WRAP: unsafe fn(
JSContext, JSContext,
&GlobalScope, &GlobalScope,

View file

@ -53,7 +53,7 @@ pub struct Promise {
permanent_js_root: Heap<JSVal>, permanent_js_root: Heap<JSVal>,
} }
/// Private helper to enable adding new methods to Rc<Promise>. /// Private helper to enable adding new methods to `Rc<Promise>`.
trait PromiseHelper { trait PromiseHelper {
fn initialize(&self, cx: SafeJSContext); fn initialize(&self, cx: SafeJSContext);
} }