Write documentation about the DOM
Commiting documentation about the DOM code will help other hackers understand faster how it all works. That also means they will be able to fix bugs and write code more quickly and efficiently. The following code elements should be documented :
- Tear-off's. Why. How.
- Event handling. See bug 238773 for the latest changes.
- Attributes. See bug 195350 for the latest changes.
- XUL DOM implementation. Some of it is implemented using XBL, some is shared with XML/HTML, but some is specfic to XUL.
- Range and selection code. Begin in nsRange.h.
Mozilla implements the W3C DOM, and tries to be backwards-compatible with Internet Explorer and/or Netscape 4 whenever possible. We currently have the Gecko DOM Reference which does a fair job describing the Mozilla DOM. However it is currently in a poor state and will likely be changed entirely in the future. Once it is in place (probably as a part of DevMo (developer.mozilla.org)), feel free to contribute to it! Web developer documentation about the Mozilla should be entirely in there, including examples and technotes.
How to send your documentation
Fabian Guisset <firstname.lastname@example.org>
is currently the official maintainer for the DOM documentation website on
mozilla.org. All questions, help, contributions, feedback, etc, should be
directed to him.
There is no formal way of getting your documentation on this site. Just send me the stuff with a few comments about who/why/how/when, I'll review it, and push it on the site if it fits.