From 4cc67f2e8e2a47b0c4e681ce9cda0374e6647997 Mon Sep 17 00:00:00 2001 From: Tobie Langel Date: Tue, 29 Dec 2009 01:53:16 +0100 Subject: [PATCH] doc: Minor cleanup. --- src/dom/dom.js | 6 +++--- src/dom/event.js | 3 ++- src/dom/form.js | 16 ++++++++-------- src/dom/selector.js | 2 +- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/src/dom/dom.js b/src/dom/dom.js index 7f0c054..e0daa1d 100644 --- a/src/dom/dom.js +++ b/src/dom/dom.js @@ -1,6 +1,6 @@ /** section: DOM, related to: Element * $(id) -> Element - * $(id...) -> [Element]... + * $(id...) -> [Element...] * - id (String | Element): A DOM node or a string that references a node's * ID. * @@ -2281,8 +2281,8 @@ Element.addMethods = function(methods) { Element.cache = { }; }; -/** section: DOM - * document.viewport +/** + * document.viewport * * The `document.viewport` namespace contains methods that return information * about the viewport — the rectangle that represents the portion of a web diff --git a/src/dom/event.js b/src/dom/event.js index d52c1da..3c28a81 100644 --- a/src/dom/event.js +++ b/src/dom/event.js @@ -621,6 +621,7 @@ * ...and then to remove: * * $('foo').stopObserving('click', this.boundHandlerMethod); // <== Right + * **/ function stopObserving(element, eventName, handler) { element = $(element); @@ -744,7 +745,7 @@ }); /** section: DOM - * document + * document * * Prototype extends the built-in `document` object with several convenience * methods related to events. diff --git a/src/dom/form.js b/src/dom/form.js index 8b8d9c1..1dc1deb 100644 --- a/src/dom/form.js +++ b/src/dom/form.js @@ -248,7 +248,7 @@ Form.Methods = { /*--------------------------------------------------------------------------*/ -/** section: DOM +/** * Form.Element * * Utilities for dealing with form controls in the DOM. @@ -359,7 +359,7 @@ Form.Element.Methods = { }, /** - * Form.Element#activate(element) -> Element + * Form.Element.activate(@element) -> Element * * Gives focus to a form control and selects its contents if it is a text * input. @@ -479,7 +479,7 @@ Form.Element.Serializers = { * Abstract **/ -/** section: DOM +/** * class Abstract.TimedObserver * * An abstract DOM element observer class, subclasses of which can be used to periodically @@ -528,7 +528,7 @@ Abstract.TimedObserver = Class.create(PeriodicalExecuter, { } }); -/** section: DOM +/** * class Form.Element.Observer < Abstract.TimedObserver * * An [[Abstract.TimedObserver]] subclass that watches for changes to a form field's value. @@ -551,7 +551,7 @@ Form.Element.Observer = Class.create(Abstract.TimedObserver, { } }); -/** section: DOM +/** * class Form.Observer < Abstract.TimedObserver * * An [[Abstract.TimedObserver]] subclass that watches for changes to a form. @@ -577,7 +577,7 @@ Form.Observer = Class.create(Abstract.TimedObserver, { /*--------------------------------------------------------------------------*/ -/** section: DOM +/** * class Abstract.EventObserver **/ Abstract.EventObserver = Class.create({ @@ -619,7 +619,7 @@ Abstract.EventObserver = Class.create({ } }); -/** section: DOM +/** * class Form.Element.EventObserver < Abstract.EventObserver **/ Form.Element.EventObserver = Class.create(Abstract.EventObserver, { @@ -628,7 +628,7 @@ Form.Element.EventObserver = Class.create(Abstract.EventObserver, { } }); -/** section: DOM +/** * class Form.EventObserver < Abstract.EventObserver **/ Form.EventObserver = Class.create(Abstract.EventObserver, { diff --git a/src/dom/selector.js b/src/dom/selector.js index 397f45f..0804337 100644 --- a/src/dom/selector.js +++ b/src/dom/selector.js @@ -1,4 +1,4 @@ -/** related to: Prototype.Selector +/** section: DOM, related to: Prototype.Selector * $$(expression...) -> [Element...] * * Returns all elements in the document that match the provided CSS selectors.