diff options
| author | Ms2ger <ms2ger@gmail.com> | 2014-06-13 18:35:50 +0200 |
|---|---|---|
| committer | Ms2ger <ms2ger@gmail.com> | 2014-06-13 19:33:19 +0200 |
| commit | db5badd36f50dd5a502999b256fff2ed6880a819 (patch) | |
| tree | 47cabdb7c10789f453cb71840d01aa5bb3056df9 /src/components/script/dom/bindings/js.rs | |
| parent | 7b35e11626edf0d288f6723f6ab50c36b6e96408 (diff) | |
| download | servo-db5badd36f50dd5a502999b256fff2ed6880a819.tar.gz servo-db5badd36f50dd5a502999b256fff2ed6880a819.zip | |
Add some blank lines to ensure rustdoc picks up the lists.
Diffstat (limited to 'src/components/script/dom/bindings/js.rs')
| -rw-r--r-- | src/components/script/dom/bindings/js.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/components/script/dom/bindings/js.rs b/src/components/script/dom/bindings/js.rs index c7b0eda9ebd..19f2d22e77a 100644 --- a/src/components/script/dom/bindings/js.rs +++ b/src/components/script/dom/bindings/js.rs @@ -8,12 +8,14 @@ //! the entire time. //! //! Here is a brief overview of the important types: +//! //! - 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 //! encountered as a field of a Rust structure. //! - Temporary<T>: a value that will remain rooted for the duration of its lifetime. //! //! The rule of thumb is as follows: +//! //! - All methods return Temporary<T>, to ensure the value remains alive until it is stored //! somewhere that is reachable by the GC. //! - All functions take &JSRef<T> arguments, to ensure that they will remain uncollected for @@ -33,6 +35,7 @@ //! misused. //! //! Other miscellaneous helper traits: +//! //! - OptionalRootable and OptionalRootedRootable: make rooting Option values easy via a `root` method //! - ResultRootable: make rooting successful Result values easy //! - TemporaryPushable: allows mutating vectors of JS<T> with new elements of JSRef/Temporary |