Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-07-23 07:13:52 +01:00
Code Issues Projects Releases Packages Wiki Activity

[script] Merge the binding design document into inline doc comments.

Browse source
This commit is contained in:
Tetsuharu OHZEKI 2015-02-10 03:35:24 +09:00
parent 83a6b5d770
commit 6500544387
3 changed files with 15 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

16
components/script/dom/mod.rs
View file

@ -67,10 +67,10 @@
//! (The result of either method can be wrapped in `Result`, if that is
//! appropriate for the type in question.)
//!
//! The latter calls the former, boxes the result, and creates a reflector for
//! it by calling `dom::bindings::utils::reflect_dom_object` (which yields
//! ownership of the object to the SpiderMonkey Garbage Collector). This is the
//! API to use when creating a DOM object.
//! The latter calls the former, boxes the result, and creates a reflector
//! corresponding to it by calling `dom::bindings::utils::reflect_dom_object`
//! (which yields ownership of the object to the SpiderMonkey Garbage Collector).
//! This is the API to use when creating a DOM object.
//!
//! The former should only be called by the latter, and by subclasses'
//! `new_inherited` methods.
@ -98,9 +98,11 @@
//! =============================
//!
//! Every DOM object has a `Reflector` as its first (transitive) member field.
//! This contains a `*mut JSObject` that points to its reflector. This field
//! is initialized by the `FooBinding::Wrap` method, called from
//! `reflect_dom_object`.
//! This contains a `*mut JSObject` that points to its reflector.
//!
//! The `FooBinding::Wrap` function creates the reflector, stores a pointer to
//! the DOM object in the reflector, and initializes the pointer to the reflector
//! in the `Reflector` field.
//!
//! The `Reflectable` trait provides a `reflector()` method that returns the
//! DOM object's `Reflector`. It is implemented automatically for DOM structs