Updating the W3C DOM documentation.

1) Added HTML Level 1. Xerces apparently wants this,
and there's certainly no reason not to have it in xml-commons.

2) Fixed the generated @param comments. The DOM WG's stylesheet
for producing Javadoc from their abstract XML markup had a glitch,
and did not reliably produce a space between the parameter name
and its description. I've submitted that as an erratum, to make sure
they fix it. Meanwhile, I've gone through and fixed them all manually.
(Not everything could be fixed by simply replacing "The" with " The";
some descriptions start with other words.)

I'm an ex-member of the DOM WG, and still on the IG, so feel free to
blame me for the fact that this wasn't caught before the DOM shipped
... and for making the change. The fact that these files are no
longer byte-for-byte identical with those supplied by the W3C will
annoy some folks, but I think it's fairly safe to assume that the DOM WG
will accept the erratum.

And we definitely want to fix it here rather than having each Apache
project patch their own copy.


git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@225942 13f79535-47bb-0310-9956-ffa450edef68

java/external/src/org/w3c/dom/ranges/Range.java

@@ -78,9 +78,9 @@ public interface Range {
 
     /**
      * Sets the attributes describing the start of the Range. 
-     * @param refNodeThe <code>refNode</code> value. This parameter must be 
+     * @param refNode The <code>refNode</code> value. This parameter must be 
      *   different from <code>null</code>.
-     * @param offsetThe <code>startOffset</code> value. 
+     * @param offset The <code>startOffset</code> value. 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if <code>refNode</code> or an ancestor 
      *   of <code>refNode</code> is an Entity, Notation, or DocumentType 
@@ -100,9 +100,9 @@ public interface Range {
 
     /**
      * Sets the attributes describing the end of a Range.
-     * @param refNodeThe <code>refNode</code> value. This parameter must be 
+     * @param refNode The <code>refNode</code> value. This parameter must be 
      *   different from <code>null</code>.
-     * @param offsetThe <code>endOffset</code> value. 
+     * @param offset The <code>endOffset</code> value. 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if <code>refNode</code> or an ancestor 
      *   of <code>refNode</code> is an Entity, Notation, or DocumentType 
@@ -122,7 +122,7 @@ public interface Range {
 
     /**
      * Sets the start position to be before a node
-     * @param refNodeRange starts before <code>refNode</code> 
+     * @param refNode Range starts before <code>refNode</code> 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if the root container of 
      *   <code>refNode</code> is not an Attr, Document, or DocumentFragment 
@@ -137,7 +137,7 @@ public interface Range {
 
     /**
      * Sets the start position to be after a node
-     * @param refNodeRange starts after <code>refNode</code> 
+     * @param refNode Range starts after <code>refNode</code> 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if the root container of 
      *   <code>refNode</code> is not an Attr, Document, or DocumentFragment 
@@ -152,7 +152,7 @@ public interface Range {
 
     /**
      * Sets the end position to be before a node. 
-     * @param refNodeRange ends before <code>refNode</code> 
+     * @param refNode Range ends before <code>refNode</code> 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if the root container of 
      *   <code>refNode</code> is not an Attr, Document, or DocumentFragment 
@@ -167,7 +167,7 @@ public interface Range {
 
     /**
      * Sets the end of a Range to be after a node 
-     * @param refNodeRange ends after <code>refNode</code>. 
+     * @param refNode Range ends after <code>refNode</code>. 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if the root container of 
      *   <code>refNode</code> is not an Attr, Document or DocumentFragment 
@@ -182,7 +182,7 @@ public interface Range {
 
     /**
      * Collapse a Range onto one of its boundary-points 
-     * @param toStartIf TRUE, collapses the Range onto its start; if FALSE, 
+     * @param toStart If TRUE, collapses the Range onto its start; if FALSE, 
      *   collapses it onto its end. 
      * @exception DOMException
      *   INVALID_STATE_ERR: Raised if <code>detach()</code> has already been 
@@ -193,7 +193,7 @@ public interface Range {
 
     /**
      * Select a node and its contents 
-     * @param refNodeThe node to select. 
+     * @param refNode The node to select. 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if an ancestor of <code>refNode</code> 
      *   is an Entity, Notation or DocumentType node or if 
@@ -208,7 +208,7 @@ public interface Range {
 
     /**
      * Select the contents within a node 
-     * @param refNodeNode to select from 
+     * @param refNode Node to select from 
      * @exception RangeException
      *   INVALID_NODE_TYPE_ERR: Raised if <code>refNode</code> or an ancestor 
      *   of <code>refNode</code> is an Entity, Notation or DocumentType node.
@@ -247,8 +247,8 @@ public interface Range {
 
     /**
      * Compare the boundary-points of two Ranges in a document.
-     * @param howA code representing the type of comparison, as defined above.
-     * @param sourceRangeThe <code>Range</code> on which this current 
+     * @param how A code representing the type of comparison, as defined above.
+     * @param sourceRange The <code>Range</code> on which this current 
      *   <code>Range</code> is compared to.
      * @return  -1, 0 or 1 depending on whether the corresponding 
      *   boundary-point of the Range is respectively before, equal to, or 
@@ -315,7 +315,7 @@ public interface Range {
      * automatically merged. If the node to be inserted is a 
      * DocumentFragment node, the children will be inserted rather than the 
      * DocumentFragment node itself.
-     * @param newNodeThe node to insert at the start of the Range 
+     * @param newNode The node to insert at the start of the Range 
      * @exception DOMException
      *   NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of the 
      *   start of the Range is read-only.
@@ -338,7 +338,7 @@ public interface Range {
     /**
      * Reparents the contents of the Range to the given node and inserts the 
      * node at the position of the start of the Range. 
-     * @param newParentThe node to surround the contents with. 
+     * @param newParent The node to surround the contents with. 
      * @exception DOMException
      *   NO_MODIFICATION_ALLOWED_ERR: Raised if an ancestor container of 
      *   either boundary-point of the Range is read-only.