From 0f5c9bfcc54c0de0239307ec42dd3662a5805048 Mon Sep 17 00:00:00 2001 From: Andrew Dupont Date: Sat, 7 Mar 2009 15:44:12 -0600 Subject: [PATCH] Updates to PDoc in DOM section. --- src/dom.js | 15 +++++++++++++++ src/dom/form.js | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/dom.js b/src/dom.js index 303e6eb..9772230 100644 --- a/src/dom.js +++ b/src/dom.js @@ -2,6 +2,21 @@ * == DOM == * Extensions to DOM elements, plus other utilities for DOM traversal * and modification. + * + * Prototype's DOM extensions represent a large portion of where you'll spend + * your time. Prototype adds many convenience methods to elements returned by + * the [[$]] function. For instance, you can write + * + * $('comments').addClassName('active').show(); + * + * to get the element with the ID of `comments`, add a class name to it, and + * show it (if it was previously hidden). + * + * In other words, Prototype adds "instance" methods to DOM nodes. This is + * made possible by direct extension of the backing DOM objects (in browsers + * that support it) and by manual extension of individual nodes (in browsers + * that do not). + * **/ diff --git a/src/dom/form.js b/src/dom/form.js index affb71d..ed03704 100644 --- a/src/dom/form.js +++ b/src/dom/form.js @@ -334,7 +334,7 @@ Form.Element.Methods = { var Field = Form.Element; -/** section: DOM, alias of: Form.Element.getValue +/** section: DOM, related to: Form * $F(element) -> String | Array **/ var $F = Form.Element.Methods.getValue;