Index: /CKEditor/trunk/_source/core/dom/node.js =================================================================== --- /CKEditor/trunk/_source/core/dom/node.js (revision 7019) +++ /CKEditor/trunk/_source/core/dom/node.js (revision 7020) @@ -5,5 +5,5 @@ /** - * @fileOverview Defines the {@link CKEDITOR.dom.node} class, which is the base + * @fileOverview Defines the {@link CKEDITOR.dom.node} class which is the base * class for classes that represent DOM nodes. */ @@ -11,5 +11,5 @@ /** * Base class for classes representing DOM nodes. This constructor may return - * and instance of classes that inherits this class, like + * an instance of a class that inherits from this class, like * {@link CKEDITOR.dom.element} or {@link CKEDITOR.dom.text}. * @augments CKEDITOR.dom.domObject @@ -87,7 +87,7 @@ { /** - * Makes this node child of another element. - * @param {CKEDITOR.dom.element} element The target element to which append - * this node. + * Makes this node a child of another element. + * @param {CKEDITOR.dom.element} element The target element to which + * this node will be appended. * @returns {CKEDITOR.dom.element} The target element. * @example @@ -143,6 +143,6 @@ /** * Inserts this element after a node. - * @param {CKEDITOR.dom.node} node The that will preceed this element. - * @returns {CKEDITOR.dom.node} The node preceeding this one after + * @param {CKEDITOR.dom.node} node The node that will precede this element. + * @returns {CKEDITOR.dom.node} The node preceding this one after * insertion. * @example @@ -161,5 +161,5 @@ /** * Inserts this element before a node. - * @param {CKEDITOR.dom.node} node The that will be after this element. + * @param {CKEDITOR.dom.node} node The node that will succeed this element. * @returns {CKEDITOR.dom.node} The node being inserted. * @example @@ -184,11 +184,12 @@ /** * Retrieves a uniquely identifiable tree address for this node. - * The tree address returns is an array of integers, with each integer + * The tree address returned is an array of integers, with each integer * indicating a child index of a DOM node, starting from - * document.documentElement. + * document.documentElement. * - * For example, assuming is the second child from ( - * being the first), and we'd like to address the third child under the - * fourth child of body, the tree address returned would be: + * For example, assuming <body> is the second child + * of <html> (<head> being the first), + * and we would like to address the third child under the + * fourth child of <body>, the tree address returned would be: * [1, 3, 2] * @@ -224,5 +225,5 @@ * @example * var element = CKEDITOR.document.getById( 'example' ); - * alert( element.getDocument().equals( CKEDITOR.document ) ); // "true" + * alert( element.getDocument().equals( CKEDITOR.document ) ); // "true" */ getDocument : function() @@ -364,5 +365,5 @@ * @example * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b> <i>next</i></div>' ); - * var first = element.getFirst().getNext(); + * var first = element.getFirst().getNext(); * alert( first.getName() ); // "i" */ @@ -384,5 +385,5 @@ * @example * var node = editor.document.getBody().getFirst(); - * var parent = node.getParent(); + * var parent = node.getParent(); * alert( node.getName() ); // "body" */ @@ -488,12 +489,13 @@ /** - * Gets the closest ancestor node of this node, specified by its node name. - * @param {String} reference The node name of the ancestor node to search, or - * an object with the names to search for (since 3.6.1) + * Gets the closest ancestor node of this node, specified by its name. + * @param {String} reference The name of the ancestor node to search or + * an object with the node names to search for. * @param {Boolean} [includeSelf] Whether to include the current - * node in the search. + * node in the search. * @returns {CKEDITOR.dom.node} The located ancestor node or null if not found. - * @example - * // Suppose we have the following HTML: + * @since 3.6.1 + * @example + * // Suppose we have the following HTML structure: * // <div id="outer"><div id="inner"><p><b>Some text</b></p></div></div> * // If node == <b> @@ -501,5 +503,5 @@ * ascendant = node.getAscendant( 'b' ); // ascendant == null * ascendant = node.getAscendant( 'b', true ); // ascendant == <b> - * ascendant = node.getAscendant( { div: 1, p: 1} ); // Searchs for the first 'div' or 'p': ascendant == <div id="inner"> + * ascendant = node.getAscendant( { div: 1, p: 1} ); // Searches for the first 'div' or 'p': ascendant == <div id="inner"> */ getAscendant : function( reference, includeSelf ) @@ -550,5 +552,5 @@ * @example * var element = CKEDITOR.dom.element.getById( 'MyElement' ); - * element.remove(); + * element.remove(); */ remove : function( preserveChildren ) @@ -653,7 +655,7 @@ /** - * Checks is this node is read-only (should not be changed). It - * additionaly returns the element, if any, which defines the read-only - * state of this node. It may be the node itself or any of its parent + * Checks if this node is read-only (should not be changed). Additionally + * it returns the element that defines the read-only state of this node + * (if present). It may be the node itself or any of its parent * nodes. * @returns {CKEDITOR.dom.element|Boolean} An element containing