Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-05 05:30:08 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add some blank lines to ensure rustdoc picks up the lists.

Browse source
This commit is contained in:
Ms2ger 2014-06-13 18:35:50 +02:00
parent 7b35e11626
commit db5badd36f
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/components/script/dom/bindings/js.rs
View file

@ -8,12 +8,14 @@
//! the entire time. //! the entire time.
//! //!
//! Here is a brief overview of the important types: //! Here is a brief overview of the important types:
//!
//! - JSRef<T>: a freely-copyable reference to a rooted value. //! - JSRef<T>: a freely-copyable reference to a rooted value.
//! - JS<T>: a pointer to JS-owned memory that can automatically be traced by the GC when //! - JS<T>: a pointer to JS-owned memory that can automatically be traced by the GC when
//! encountered as a field of a Rust structure. //! encountered as a field of a Rust structure.
//! - Temporary<T>: a value that will remain rooted for the duration of its lifetime. //! - Temporary<T>: a value that will remain rooted for the duration of its lifetime.
//! //!
//! The rule of thumb is as follows: //! The rule of thumb is as follows:
//!
//! - All methods return Temporary<T>, to ensure the value remains alive until it is stored //! - All methods return Temporary<T>, to ensure the value remains alive until it is stored
//! somewhere that is reachable by the GC. //! somewhere that is reachable by the GC.
//! - All functions take &JSRef<T> arguments, to ensure that they will remain uncollected for //! - All functions take &JSRef<T> arguments, to ensure that they will remain uncollected for
@ -33,6 +35,7 @@
//! misused. //! misused.
//! //!
//! Other miscellaneous helper traits: //! Other miscellaneous helper traits:
//!
//! - OptionalRootable and OptionalRootedRootable: make rooting Option values easy via a `root` method //! - OptionalRootable and OptionalRootedRootable: make rooting Option values easy via a `root` method
//! - ResultRootable: make rooting successful Result values easy //! - ResultRootable: make rooting successful Result values easy
//! - TemporaryPushable: allows mutating vectors of JS<T> with new elements of JSRef/Temporary //! - TemporaryPushable: allows mutating vectors of JS<T> with new elements of JSRef/Temporary