auto merge of #5501 : Ms2ger/servo/docs, r=jdm

Most of this documentation is based on
<https://developer.mozilla.org/en-US/docs/Mozilla/WebIDL_bindings>.

2 files changed, 109 insertions, 0 deletions

diff --git a/components/script/dom/bindings/mod.rs b/components/script/dom/bindings/mod.rs
index f2cfb642131..5fd9193a996 100644
--- a/components/script/dom/bindings/mod.rs
+++ b/components/script/dom/bindings/mod.rs
@@ -24,6 +24,113 @@
 //! they call a Rust function in the generated glue code. This glue code does
 //! some sanity checks and [argument conversions](conversions/index.html), and
 //! calls into API implementation for the DOM object.
+//!
+//! Rust reflections of WebIDL constructs
+//! =====================================
+//!
+//! WebIDL members are turned into methods on the DOM object (static methods
+//! for a static members and instance methods for regular members).
+//!
+//! The instance methods for an interface `Foo` are defined on a
+//! `dom::bindings::codegen::Bindings::FooBindings::FooMethods` trait. This
+//! trait is then implemented for `JSRef<'a, Foo>`.
+//!
+//! The return type and argument types are determined [as described below]
+//! (#rust-reflections-of-webidl-types).
+//! In addition to those, all methods that are [allowed to throw]
+//! (#throwing-exceptions) will have the return value wrapped in
+//! [`Fallible<T>`](error/type.Fallible.html).
+//! Methods that use certain WebIDL types like `any` or `object` will get a
+//! `*mut JSContext` argument prepended to the argument list. Static methods
+//! will be passed a [`GlobalRef`](global/enum.GlobalRef.html) for the relevant
+//! global. This argument comes before the `*mut JSContext` argument, if any.
+//!
+//! Rust reflections of WebIDL operations (methods)
+//! -----------------------------------------------
+//!
+//! A WebIDL operation is turned into one method for every overload.
+//! The first overload gets the base name, and consecutive overloads have an
+//! underscore appended to the name.
+//!
+//! The base name of the Rust method is simply the name of the WebIDL operation
+//! with the first letter converted to uppercase.
+//!
+//! Rust reflections of WebIDL attributes
+//! -------------------------------------
+//!
+//! A WebIDL attribute is turned into a pair of methods: one for the getter and
+//! one for the setter. A readonly attribute only has a getter and no setter.
+//!
+//! The getter's name is the name of the attribute with the first letter
+//! converted to uppercase. It has `Get` prepended to it if the type of the
+//! attribute is nullable or if the getter can throw.
+//!
+//! The method signature for the getter looks just like an operation with no
+//! arguments and the attribute's type as the return type.
+//!
+//! The setter's name is `Set` followed by the name of the attribute with the
+//! first letter converted to uppercase. The method signature looks just like
+//! an operation with a void return value and a single argument whose type is
+//! the attribute's type.
+//!
+//! Rust reflections of WebIDL constructors
+//! ---------------------------------------
+//!
+//! A WebIDL constructor is turned into a static class method named
+//! `Constructor`. The arguments of this method will be the arguments of the
+//! WebIDL constructor, with a `GlobalRef` for the relevant global prepended.
+//! The return value of the constructor for MyInterface is exactly the same as
+//! that of a method returning an instance of MyInterface. Constructors are
+//! always [allowed to throw](#throwing-exceptions).
+//!
+//! Rust reflections of WebIDL types
+//! --------------------------------
+//!
+//! The exact Rust representation for WebIDL types can depend on the precise
+//! way that they're being used (e.g., return values and arguments might have
+//! different representations).
+//!
+//! Optional arguments which do not have a default value are represented by
+//! wrapping `Option<T>` around the representation of the argument type.
+//! Optional arguments which do have a default value are represented by the
+//! argument type itself, set to the default value if the argument was not in
+//! fact passed in.
+//!
+//! Variadic WebIDL arguments are represented by wrapping a `Vec<T>` around the
+//! representation of the argument type.
+//!
+//! See [the type mapping for particular types](conversions/index.html).
+//!
+//! Rust reflections of stringifiers
+//! --------------------------------
+//!
+//! *To be written.*
+//!
+//! Rust reflections of legacy callers
+//! ---------------------------------
+//!
+//! Legacy callers are not yet implemented.
+//!
+//! Rust reflections of getters and setters
+//! ---------------------------------------
+//!
+//! *To be written.*
+//!
+//! Throwing exceptions
+//! ===================
+//!
+//! WebIDL methods, getters, and setters that need to throw exceptions need to
+//! be explicitly marked as such with the `[Throws]`, `[GetterThrows]` and
+//! `[SetterThrows]` custom attributes.
+//!
+//! `[Throws]` applies to both methods and attributes; for attributes it means
+//! both the getter and the setter (if any) can throw. `[GetterThrows]` applies
+//! only to attributes. `[SetterThrows]` applies only to writable attributes.
+//!
+//! The corresponding Rust methods will have the return value wrapped in
+//! [`Fallible<T>`](error/type.Fallible.html). To throw an exception, simply
+//! return `Err()` from the method with the appropriate [error value]
+//! (error/enum.Error.html).
 
 #![allow(unsafe_code)]
 #![deny(missing_docs, non_snake_case)]
diff --git a/components/script/dom/mod.rs b/components/script/dom/mod.rs
index f1f9c58fad8..543521ad116 100644
--- a/components/script/dom/mod.rs
+++ b/components/script/dom/mod.rs
@@ -172,6 +172,8 @@
 //!   `dom::bindings::codegen::Bindings::FooBindings::FooMethods` trait for
 //!   `JSRef<Foo>`.
 //!
+//! More information is available in the [bindings module](bindings/index.html).
+//!
 //! Accessing DOM objects from layout
 //! =================================
 //!