You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by mr...@apache.org on 2006/09/24 00:58:24 UTC
svn commit: r449328 - /xerces/java/trunk/src/org/apache/xerces/dom/
Author: mrglavas
Date: Sat Sep 23 15:58:23 2006
New Revision: 449328
URL: http://svn.apache.org/viewvc?view=rev&rev=449328
Log:
Various Javadoc fixes.
Modified:
xerces/java/trunk/src/org/apache/xerces/dom/AttrImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/AttrNSImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/AttributeMap.java
xerces/java/trunk/src/org/apache/xerces/dom/CoreDocumentImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/DOMConfigurationImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/DOMMessageFormatter.java
xerces/java/trunk/src/org/apache/xerces/dom/DOMStringListImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/DeferredDocumentImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/DocumentImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/ElementImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/ElementNSImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/NamedNodeMapImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/NodeImpl.java
xerces/java/trunk/src/org/apache/xerces/dom/PSVIElementNSImpl.java
Modified: xerces/java/trunk/src/org/apache/xerces/dom/AttrImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/AttrImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/AttrImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/AttrImpl.java Sat Sep 23 15:58:23 2006
@@ -1031,7 +1031,7 @@
* NodeList method: Return the Nth immediate child of this node, or
* null if the index is out of bounds.
* @return org.w3c.dom.Node
- * @param Index int
+ * @param index int
*/
public Node item(int index) {
@@ -1073,12 +1073,12 @@
* Checks if a type is derived from another by restriction. See:
* http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
*
- * @param ancestorNS
+ * @param typeNamespaceArg
* The namspace of the ancestor type declaration
- * @param ancestorName
+ * @param typeNameArg
* The name of the ancestor type declaration
- * @param type
- * The reference type definition
+ * @param derivationMethod
+ * The derivation method
*
* @return boolean True if the type is derived by restriciton for the
* reference type
Modified: xerces/java/trunk/src/org/apache/xerces/dom/AttrNSImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/AttrNSImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/AttrNSImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/AttrNSImpl.java Sat Sep 23 15:58:23 2006
@@ -311,12 +311,12 @@
* Checks if a type is derived from another by restriction. See:
* http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
*
- * @param ancestorNS
+ * @param typeNamespaceArg
* The namspace of the ancestor type declaration
- * @param ancestorName
+ * @param typeNameArg
* The name of the ancestor type declaration
- * @param type
- * The reference type definition
+ * @param derivationMethod
+ * The derivation method
*
* @return boolean True if the type is derived by restriciton for the
* reference type
Modified: xerces/java/trunk/src/org/apache/xerces/dom/AttributeMap.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/AttributeMap.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/AttributeMap.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/AttributeMap.java Sat Sep 23 15:58:23 2006
@@ -357,7 +357,7 @@
* The namespace URI of the node to remove.
* When it is null or an empty string, this
* method behaves like removeNamedItem.
- * @param The local name of the node to remove. If the
+ * @param name The local name of the node to remove. If the
* removed attribute is known to have a default
* value, an attribute immediately appears
* containing the default value.
Modified: xerces/java/trunk/src/org/apache/xerces/dom/CoreDocumentImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/CoreDocumentImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/CoreDocumentImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/CoreDocumentImpl.java Sat Sep 23 15:58:23 2006
@@ -1358,7 +1358,9 @@
* as its OwnerDoc. (REC-DOM-Level-1-19981001 left the process of building
* DTD information unspecified.)
*
- * @param name The name of the Entity we wish to provide a value for.
+ * @param qualifiedName
+ * @param publicID
+ * @param systemID
*
* @throws DOMException(NOT_SUPPORTED_ERR) for HTML documents, where
* DTDs are not permitted. (HTML not yet implemented.)
Modified: xerces/java/trunk/src/org/apache/xerces/dom/DOMConfigurationImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/DOMConfigurationImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/DOMConfigurationImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/DOMConfigurationImpl.java Sat Sep 23 15:58:23 2006
@@ -429,8 +429,8 @@
* has ended. If a client application wants to terminate
* parsing early, it should throw an exception.
*
- * @param source The input source for the top-level of the
- * XML document.
+ * @param inputSource The input source for the top-level of the
+ * XML document.
*
* @exception XNIException Any XNI exception, possibly wrapping
* another exception.
Modified: xerces/java/trunk/src/org/apache/xerces/dom/DOMMessageFormatter.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/DOMMessageFormatter.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/DOMMessageFormatter.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/DOMMessageFormatter.java Sat Sep 23 15:58:23 2006
@@ -131,8 +131,8 @@
}
/**
- * setLocale to be used by the formatter.
- * @param locale
+ * Set Locale to be used by the formatter.
+ * @param dlocale
*/
public static void setLocale(Locale dlocale){
locale = dlocale;
Modified: xerces/java/trunk/src/org/apache/xerces/dom/DOMStringListImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/DOMStringListImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/DOMStringListImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/DOMStringListImpl.java Sat Sep 23 15:58:23 2006
@@ -78,7 +78,7 @@
* DOM Internal:
* Add a <code>DOMString</code> to the list.
*
- * @param domString A string to add to the list
+ * @param param A string to add to the list
*/
public void add(String param) {
fStrings.add(param);
Modified: xerces/java/trunk/src/org/apache/xerces/dom/DeferredDocumentImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/DeferredDocumentImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/DeferredDocumentImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/DeferredDocumentImpl.java Sat Sep 23 15:58:23 2006
@@ -374,12 +374,18 @@
} // createDeferredElement(String,String):int
- /** @deprecated. Creates an element node in the table. */
+ /**
+ * Creates an element node in the table.
+ * @deprecated
+ */
public int createDeferredElement(String elementName) {
return createDeferredElement(null, elementName);
}
- /** @deprecated. Creates an element node with a URI in the table. */
+ /**
+ * Creates an element node with a URI in the table.
+ * @deprecated
+ */
public int createDeferredElement(String elementURI, String elementName) {
// create node
@@ -454,7 +460,10 @@
return attrNodeIndex;
}
- /** @deprecated. Sets an attribute on an element node.*/
+ /**
+ * Sets an attribute on an element node.
+ * @deprecated
+ */
public int setDeferredAttribute(int elementNodeIndex,
String attrName, String attrURI,
String attrValue, boolean specified) {
Modified: xerces/java/trunk/src/org/apache/xerces/dom/DocumentImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/DocumentImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/DocumentImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/DocumentImpl.java Sat Sep 23 15:58:23 2006
@@ -908,7 +908,7 @@
* @param node The node to dispatch to
* @param enclosingAttr The Attr node (if any) whose value has been changed
* as a result of the DOM operation. Null if none such.
- * @param oldValue The String value previously held by the
+ * @param oldvalue The String value previously held by the
* enclosingAttr. Ignored if none such.
* @param change Type of modification to the attr. See
* MutationEvent.attrChange
@@ -963,7 +963,6 @@
* preparation for later generating DOMAttrModified events.
* Determines whether this node is within an Attr
* @param node node to get enclosing attribute for
- * @return either a description of that Attr, or null if none such.
*/
protected void saveEnclosingAttr(NodeImpl node) {
savedEnclosingAttr = null;
Modified: xerces/java/trunk/src/org/apache/xerces/dom/ElementImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/ElementImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/ElementImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/ElementImpl.java Sat Sep 23 15:58:23 2006
@@ -749,7 +749,7 @@
* namespace URI is already present in the element, it is replaced
* by the new one.
*
- * @param Attr The Attr node to add to the attribute list. When
+ * @param newAttr The Attr node to add to the attribute list. When
* the Node has no namespaceURI, this method behaves
* like setAttributeNode.
* @return Attr If the newAttr attribute replaces an existing attribute
@@ -1041,12 +1041,12 @@
* Checks if a type is derived from another by restriction. See:
* http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
*
- * @param ancestorNS
+ * @param typeNamespaceArg
* The namspace of the ancestor type declaration
- * @param ancestorName
+ * @param typeNameArg
* The name of the ancestor type declaration
- * @param type
- * The reference type definition
+ * @param derivationMethod
+ * The derivation method
*
* @return boolean True if the type is derived by restriciton for the
* reference type
Modified: xerces/java/trunk/src/org/apache/xerces/dom/ElementNSImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/ElementNSImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/ElementNSImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/ElementNSImpl.java Sat Sep 23 15:58:23 2006
@@ -449,12 +449,12 @@
* Checks if a type is derived from another by restriction. See:
* http://www.w3.org/TR/DOM-Level-3-Core/core.html#TypeInfo-isDerivedFrom
*
- * @param ancestorNS
+ * @param typeNamespaceArg
* The namspace of the ancestor type declaration
- * @param ancestorName
+ * @param typeNameArg
* The name of the ancestor type declaration
- * @param type
- * The reference type definition
+ * @param derivationMethod
+ * The derivation method
*
* @return boolean True if the type is derived by restriciton for the
* reference type
Modified: xerces/java/trunk/src/org/apache/xerces/dom/NamedNodeMapImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/NamedNodeMapImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/NamedNodeMapImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/NamedNodeMapImpl.java Sat Sep 23 15:58:23 2006
@@ -284,7 +284,7 @@
* The namespace URI of the node to remove.
* When it is null or an empty string, this
* method behaves like removeNamedItem.
- * @param The local name of the node to remove.
+ * @param name The local name of the node to remove.
* @return Node The node removed from the map if a node with such
* a local name and namespace URI exists.
* @throws NOT_FOUND_ERR: Raised if there is no node named
Modified: xerces/java/trunk/src/org/apache/xerces/dom/NodeImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/NodeImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/NodeImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/NodeImpl.java Sat Sep 23 15:58:23 2006
@@ -558,7 +558,7 @@
* @see ParentNode
*
* @return org.w3c.dom.Node
- * @param Index int
+ * @param index int
*/
public Node item(int index) {
return null;
@@ -1506,8 +1506,8 @@
* Look up the namespace URI associated to the given prefix, starting from this node.
* Use lookupNamespaceURI(null) to lookup the default namespace
*
- * @param namespaceURI
- * @return th URI for the namespace
+ * @param specifiedPrefix
+ * @return the URI for the namespace
* @since DOM Level 3
*/
public String lookupNamespaceURI(String specifiedPrefix) {
@@ -1682,9 +1682,6 @@
* <code>Text</code> nodes, as well as any user data or event listeners
* registered on the nodes.
* @param arg The node to compare equality with.
- * @param deep If <code>true</code>, recursively compare the subtrees; if
- * <code>false</code>, compare only the nodes themselves (and its
- * attributes, if it is an <code>Element</code>).
* @return If the nodes, and possibly subtrees are equal,
* <code>true</code> otherwise <code>false</code>.
* @since DOM Level 3
Modified: xerces/java/trunk/src/org/apache/xerces/dom/PSVIElementNSImpl.java
URL: http://svn.apache.org/viewvc/xerces/java/trunk/src/org/apache/xerces/dom/PSVIElementNSImpl.java?view=diff&rev=449328&r1=449327&r2=449328
==============================================================================
--- xerces/java/trunk/src/org/apache/xerces/dom/PSVIElementNSImpl.java (original)
+++ xerces/java/trunk/src/org/apache/xerces/dom/PSVIElementNSImpl.java Sat Sep 23 15:58:23 2006
@@ -237,7 +237,7 @@
/**
* Copy PSVI properties from another psvi item.
*
- * @param attr the source of attribute PSVI items
+ * @param elem the source of element PSVI items
*/
public void setPSVI(ElementPSVI elem) {
this.fDeclaration = elem.getElementDeclaration();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xerces.apache.org
For additional commands, e-mail: commits-help@xerces.apache.org