ws-axis-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject svn commit: r366034 - /webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/
Date Thu, 05 Jan 2006 00:09:41 GMT
Author: dims
Date: Wed Jan  4 16:09:34 2006
New Revision: 366034

URL: http://svn.apache.org/viewcvs?rev=366034&view=rev
Log:
javadoc updates

Modified:
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttrImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttributeMap.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/CharacterImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ChildNode.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMMessageFormatter.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMNavigator.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMStAXWrapper.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DocumentImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ElementImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NamedNodeMapImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeListImpl.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ParentNode.java
    webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/TextImpl.java

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttrImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttrImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttrImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttrImpl.java Wed Jan  4 16:09:34 2006
@@ -94,7 +94,7 @@
 	///org.w3c.dom.Node methods
 	///
 	/**
-	 * Returns the name of this attribute 
+	 * Returns the name of this attribute. 
 	 */
 	public String getNodeName() {
 		return (this.namespace != null && !"".equals(this.namespace)) ? this.namespace
@@ -104,7 +104,7 @@
 	}
 	
 	/**
-	 * Returns the node type
+	 * Returns the node type.
 	 * @see org.w3c.dom.Node#getNodeType()
 	 */
 	public short getNodeType() {
@@ -112,7 +112,7 @@
 	}
 	
 	/**
-	 * returns the value of this attribute
+	 * Returns the value of this attribute.
 	 * @see org.w3c.dom.Node#getNodeValue()
 	 */
 	public String getNodeValue() throws DOMException {
@@ -120,7 +120,7 @@
 	}
 	
 	/**
-	 * returns the value of this attribute
+	 * Returns the value of this attribute.
 	 * @see org.w3c.dom.Attr#getValue()
 	 */
 	public String getValue() {
@@ -135,7 +135,7 @@
 	}
 	
 	/**
-	 * Returns the owner element
+	 * Returns the owner element.
 	 * @see org.w3c.dom.Attr#getOwnerElement()
 	 */
 	public Element getOwnerElement() {
@@ -149,8 +149,8 @@
 	}
 
 	/**
-	 * Not supported: Cannot detach attributes
-	 * Use the operations available in the owner node
+	 * Not supported: Cannot detach attributes.
+	 * Use the operations available in the owner node.
 	 * @see org.apache.axis2.om.OMNode#detach()
 	 */
 	public OMNode detach() throws OMException {
@@ -158,8 +158,8 @@
 	}
 
 	/**
-	 * Not supported: Cannot discard attributes
-	 * Use the operations available in the owner node
+	 * Not supported: Cannot discard attributes.
+	 * Use the operations available in the owner node.
 	 * @see org.apache.axis2.om.OMNode#discard()
 	 */
 	public void discard() throws OMException {
@@ -167,7 +167,7 @@
 	}
 
 	/**
-	 * Returns the type of this Attr node
+	 * Returns the type of this attribute node.
 	 * @see org.apache.axis2.om.OMNode#getType()
 	 */
 	public int getType() {
@@ -176,8 +176,8 @@
 
 	/**
 	 * This is not supported since attributes serialization is handled by
-	 * the serialization of the owner nodes
-	 * @see org.apache.axis2.om.OMNode#serialize(org.apache.axis2.om.impl.OMOutputImpl)
+	 * the serialization of the owner nodes.
+	 * @see org.apache.axis2.om.impl.OMNodeEx#serialize(org.apache.axis2.om.impl.OMOutputImpl)
 	 */
 	public void serialize(OMOutputImpl omOutput) throws XMLStreamException {
 		throw new UnsupportedOperationException("Not supported");
@@ -185,15 +185,15 @@
 
 	/**
 	 * This is not supported since attributes serialization is handled by
-	 * the serialization of the owner nodes
-	 * @see org.apache.axis2.om.OMNode#serializeAndConsume(org.apache.axis2.om.impl.OMOutputImpl)
+	 * the serialization of the owner nodes.
+	 * @see org.apache.axis2.om.impl.OMNodeEx#serializeAndConsume(org.apache.axis2.om.impl.OMOutputImpl)
 	 */
 	public void serializeAndConsume(OMOutputImpl omOutput) throws XMLStreamException {
 		throw new UnsupportedOperationException("Not supported");
 	}
 
 	/**
-	 * Returns the namespace of the attribute as an <code>OMNamespace</code>
+	 * Returns the namespace of the attribute as an <code>OMNamespace</code>.
 	 * @see org.apache.axis2.om.OMAttribute#getNamespace()
 	 */
 	public OMNamespace getNamespace() {
@@ -201,7 +201,7 @@
 	}
 
 	/**
-	 * Returns a qname representing the attribute 
+	 * Returns a qname representing the attribute.
 	 * @see org.apache.axis2.om.OMAttribute#getQName()
 	 */
 	public QName getQName() {
@@ -212,7 +212,7 @@
 	}
 
 	/**
-	 * Returns the attribute value 
+	 * Returns the attribute value.
 	 * @see org.apache.axis2.om.OMAttribute#getAttributeValue()
 	 */
 	public String getAttributeValue() {
@@ -220,7 +220,7 @@
 	}
 
 	/**
-	 * Sets the attribute name
+	 * Sets the name of attribute.
 	 * @see org.apache.axis2.om.OMAttribute#setLocalName(java.lang.String)
 	 */
 	public void setLocalName(String localName) {
@@ -228,7 +228,7 @@
 	}
 
 	/**
-	 * Sets the namespace of this attribute node
+	 * Sets the namespace of this attribute node.
 	 * @see org.apache.axis2.om.OMAttribute#setOMNamespace(org.apache.axis2.om.OMNamespace)
 	 */
 	public void setOMNamespace(OMNamespace omNamespace) {
@@ -236,7 +236,7 @@
 	}
 
 	/**
-	 * Sets the attribute value
+	 * Sets the attribute value.
 	 * @see org.apache.axis2.om.OMAttribute#setAttributeValue(java.lang.String)
 	 */
 	public void setAttributeValue(String value) {
@@ -248,7 +248,7 @@
 	}
 
 	/**
-	 * Sets the parent element to the given OMContainer
+	 * Sets the parent element to the given OMContainer.
 	 * @see org.apache.axis2.om.impl.OMNodeEx#setParent(org.apache.axis2.om.OMContainer)
 	 */
 	public void setParent(OMContainer element) {
@@ -256,7 +256,7 @@
 	}
 
 	/**
-	 * Sets the type
+	 * Sets the type.
 	 * NOT IMPLEMENTED: Unnecessary
 	 * @see org.apache.axis2.om.impl.OMNodeEx#setType(int)
 	 */
@@ -265,7 +265,7 @@
 	}
 
 	/**
-	 * @return Returns the used.
+	 * @return Returns boolean.
 	 */
 	protected boolean isUsed() {
 		return used;
@@ -279,7 +279,7 @@
 	}
 
 	/**
-	 * Sets the value of the attribute
+	 * Sets the value of the attribute.
 	 * @see org.w3c.dom.Attr#setValue(java.lang.String)
 	 */
 	public void setValue(String value) throws DOMException {
@@ -288,7 +288,7 @@
 	}
 
 	/**
-	 * Returns the parent node of this attribute
+	 * Returns the parent node of this attribute.
 	 * @see org.apache.axis2.om.OMNode#getParent()
 	 */
 	public OMContainer getParent() {
@@ -296,7 +296,7 @@
 	}
 	
 	/**
-	 * Returns the attribute name
+	 * Returns the attribute name.
 	 * @see org.w3c.dom.Node#getLocalName()
 	 */
     public String getLocalName() {
@@ -305,7 +305,7 @@
     }
 
     /**
-     * Retuns the namespace URI of this attr node
+     * Returns the namespace URI of this attr node.
      * @see org.w3c.dom.Node#getNamespaceURI()
      */
     public String getNamespaceURI() {
@@ -320,7 +320,7 @@
 	}
     
     /**
-     * Returns the namespace prefix of this attr node
+     * Returns the namespace prefix of this attr node.
      * @see org.w3c.dom.Node#getPrefix()
      */
     public String getPrefix()

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttributeMap.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttributeMap.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttributeMap.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/AttributeMap.java Wed Jan  4 16:09:34 2006
@@ -43,7 +43,7 @@
 	}
 	
 	/**
-	 * This is mostly a copy of the Xerces impl
+	 * Almost a copy of the Xerces impl.
 	 */
 	public Node setNamedItem(Node attribute) throws DOMException {
         
@@ -108,7 +108,7 @@
 	}
 	
 	/**
-	 * This is mostly a copy of the Xerces impl
+	 * Almost a copy of the Xerces impl.
 	 */
 	public Node setNamedItemNS(Node attribute) throws DOMException {
 		if (isReadOnly()) {
@@ -174,7 +174,7 @@
 	
 
     /**
-     * BORROWED from Xerces impl
+     * BORROWED from Xerces impl.
      * Cloning a NamedNodeMap is a DEEP OPERATION; it always clones
      * all the nodes contained in the map.
      */
@@ -188,7 +188,7 @@
     } // cloneMap():AttributeMap
 
     /**
-     * BORROWED from Xerces impl
+     * BORROWED from Xerces impl.
      */
     protected void cloneContent(NamedNodeMapImpl srcmap) {
         Vector srcnodes = srcmap.nodes;

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/CharacterImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/CharacterImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/CharacterImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/CharacterImpl.java Wed Jan  4 16:09:34 2006
@@ -19,8 +19,8 @@
 import org.w3c.dom.DOMException;
 
 /**
- * This implements the OMText operations which are to be
- * inherited by TextImpl, CommentImpl, CDATASectionImpl
+ * This implements the OMText operations which are to be inherited by 
+ * TextImpl, CommentImpl, CDATASectionImpl.
  */
 public abstract class CharacterImpl extends ChildNode implements CharacterData {
 
@@ -65,7 +65,7 @@
 	}
 	
 	/**
-	 * If the given data is null the content will be deleted
+	 * If the given data is null the content will be deleted.
 	 */
 	public void replaceData(int offset, int count, String data) throws DOMException {
 		
@@ -98,14 +98,14 @@
 	
 	
 	/**
-	 * Returns the value of the data
+	 * Returns the value of the data.
 	 */
 	public String getData() throws DOMException {
 		return (this.textValue != null) ? this.textValue.toString() : "";
 	}
 	
 	/**
-	 * Inserts a sting at the specified offset
+	 * Inserts a string at the specified offset.
 	 */
 	public void insertData(int offset, String data) throws DOMException {
 		int length = this.textValue.length();
@@ -129,7 +129,7 @@
 	}
 
 	/**
-	 * Sets the text value of data
+	 * Sets the text value of data.
 	 */
 	public void setData(String data) throws DOMException {
 		if (!this.isReadonly()) {
@@ -144,7 +144,7 @@
 	
 	/**
 	 * Extracts a range of data from the node.
-	 * @return The specified substring. If the sum of offset and count exceeds
+	 * @return Returns the specified substring. If the sum of offset and count exceeds
 	 * the length, then all 16-bit units to the end of the data are returned.
 	 */
 	public String substringData(int offset, int count) throws DOMException {
@@ -160,7 +160,7 @@
 	}
 	
 	/**
-	 * returns the length of the sting value 
+	 * Returns the length of the string value.
 	 */
 	public int getLength() {
 		return this.textValue.length();

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ChildNode.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ChildNode.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ChildNode.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ChildNode.java Wed Jan  4 16:09:34 2006
@@ -120,7 +120,7 @@
     }
 
     /**
-     * Insert the given sibling next to this item
+     * Inserts the given sibling next to this item.
      */
     public void insertSiblingAfter(OMNode sibling) throws OMException {
 
@@ -143,7 +143,7 @@
     }
 
     /**
-     * Insert the given sibling before this item
+     * Inserts the given sibling before this item.
      */
     public void insertSiblingBefore(OMNode sibling) throws OMException {
 //		((OMNodeEx)sibling).setParent(this.parentNode);

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMMessageFormatter.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMMessageFormatter.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMMessageFormatter.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMMessageFormatter.java Wed Jan  4 16:09:34 2006
@@ -51,7 +51,7 @@
      *                  of the arguments must match that of the placeholders
      *                  in the actual message.
      *
-     * @return          the formatted message.
+     * @return          Returns the formatted message.
      *
      * @throws MissingResourceException Thrown if the message with the
      *                                  specified key cannot be found.
@@ -113,7 +113,7 @@
         return null;
     }
     /**
-     * Initialize Message Formatter.
+     * Initializes Message Formatter.
      */
     public static void init(){
         if (locale != null) {
@@ -128,7 +128,7 @@
     }
     
     /**
-     * setLocale to be used by the formatter.
+     * Sets Locale to be used by the formatter.
      * @param locale
      */
     public static void setLocale(Locale dlocale){

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMNavigator.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMNavigator.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMNavigator.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMNavigator.java Wed Jan  4 16:09:34 2006
@@ -21,10 +21,10 @@
 import org.apache.axis2.om.OMNode;
 
 /**
- * This is exatly the same as org.apache.axis2.om.impl.om.OMNavigator, only the
- * llom specifics are changed to dom
- * Refer to the testClass to find out how to use
- * features like isNavigable, isComplete and step
+ * This is exactly the same as org.apache.axis2.om.impl.om.OMNavigator, only the
+ * llom specifics are changed to dom.
+ * Refer to the testClass to find out how to use features like isNavigable, 
+ * isComplete and step.
  */
 public class DOMNavigator {
     /**
@@ -68,13 +68,13 @@
     private boolean start = true;
 
     /**
-     * Constructor OMNavigator
+     * Constructor OMNavigator.
      */
     public DOMNavigator() {
     }
 
     /**
-     * Constructor OMNavigator
+     * Constructor OMNavigator.
      *
      * @param node
      */
@@ -83,7 +83,7 @@
     }
 
     /**
-     * Method init
+     * Method init.
      *
      * @param node
      */
@@ -94,11 +94,11 @@
     }
 
     /**
-     * get the next node
+     * Gets the next node.
      *
-     * @return OMnode in the sequence of preorder traversal. Note however that an element node is
+     * @return Returns OMNode in the sequence of preorder traversal. Note however that an element node is
      *         treated slightly differently. Once the element is passed it returns the same element in the
-     *         next encounter as well
+     *         next encounter as well.
      */
     public OMNode next() {
         if (next == null) {
@@ -148,9 +148,9 @@
     }
 
     /**
-     * Method visited
+     * Method visited.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean visited() {
         return visited;
@@ -158,10 +158,10 @@
 
     /**
      * This is a very special method. This allows the navigator to step
-     * once it has reached the existing om. At this point the isNavigable
+     * once it has reached the existing OM. At this point the isNavigable
      * method will return false but the isComplete method may return false
      * which means that the navigating the given element is not complete but
-     * the navigator cannot proceed
+     * the navigator cannot proceed.
      */
     public void step() {
         if (!end) {
@@ -171,9 +171,9 @@
     }
 
     /**
-     * the navigable status
+     * Returns the navigable status.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isNavigable() {
         if (end) {
@@ -184,9 +184,9 @@
     }
 
     /**
-     * The completed status
+     * Returns the completed status.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isCompleted() {
         return end;

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMStAXWrapper.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMStAXWrapper.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMStAXWrapper.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DOMStAXWrapper.java Wed Jan  4 16:09:34 2006
@@ -38,11 +38,11 @@
 import java.util.Stack;
 
 /**
- * This is Exactly the same as org.apache.axis2.om.impl.llom.OMStAXWrapper
- * BUT this uses the org.apache.axis2.om.impl.dom.DOMNavigator
+ * This is exactly the same as org.apache.axis2.om.impl.llom.OMStAXWrapper.
+ * BUT this uses the org.apache.axis2.om.impl.dom.DOMNavigator.
  * 
  * Note  - This class also implements the streaming constants interface
- * to get access to the StAX constants
+ * to get access to the StAX constants.
  */
 public class DOMStAXWrapper implements XMLStreamReader, XMLStreamConstants {
     /**
@@ -70,10 +70,10 @@
      */
     private boolean isFirst = true;
 
-    // navigable means the output should be taken from the navigator
+    // Navigable means the output should be taken from the navigator
     // as soon as the navigator returns a null navigable will be reset
     // to false and the subsequent events will be taken from the builder
-    // or the parser directly
+    // or the parser directly.
 
     /**
      * Field NAVIGABLE
@@ -137,7 +137,7 @@
     private boolean needToThrowEndDocument = false;
 
     /**
-     * Method setAllowSwitching
+     * Method setAllowSwitching.
      *
      * @param b
      */
@@ -146,9 +146,9 @@
     }
 
     /**
-     * Method isAllowSwitching
+     * Method isAllowSwitching.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isAllowSwitching() {
         return switchingAllowed;
@@ -157,9 +157,9 @@
     /**
      * When constructing the OMStaxWrapper, the creator must produce the
      * builder (an instance of the OMXMLparserWrapper of the input) and the
-     * Element Node to start parsing. The wrapper wil parse(proceed) until
-     * the end of the given element. hence care should be taken to pass the
-     * root element if the entire document is needed
+     * Element Node to start parsing. The wrapper parses(proceed) until
+     * the end of the given element. Hence care must be taken to pass the
+     * root element if the entire document is needed.
      *
      * @param builder
      * @param startNode
@@ -195,7 +195,7 @@
     }
 
     /**
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getPrefix()
      */
     public String getPrefix() {
@@ -215,7 +215,7 @@
     }
 
     /**
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getNamespaceURI()
      */
     public String getNamespaceURI() {
@@ -236,7 +236,7 @@
     }
 
     /**
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#hasName()
      */
     public boolean hasName() {
@@ -249,7 +249,7 @@
     }
 
     /**
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getLocalName()
      */
     public String getLocalName() {
@@ -267,7 +267,7 @@
     }
 
     /**
-     * @return
+     * @return Returns QName.
      * @see javax.xml.stream.XMLStreamReader#getName()
      */
     public QName getName() {
@@ -284,7 +284,7 @@
     }
 
     /**
-     * @return
+     * @return Returns boolean.
      * @see javax.xml.stream.XMLStreamReader#hasText()
      */
     public boolean hasText() {
@@ -294,7 +294,7 @@
     }
 
     /**
-     * @return
+     * @return Returns int.
      * @see javax.xml.stream.XMLStreamReader#getTextLength()
      */
     public int getTextLength() {
@@ -309,7 +309,7 @@
     }
 
     /**
-     * @return
+     * @return Returns int.
      * @see javax.xml.stream.XMLStreamReader#getTextStart()
      */
     public int getTextStart() {
@@ -327,7 +327,7 @@
      * @param chars
      * @param i1
      * @param i2
-     * @return
+     * @return Returns int.
      * @throws XMLStreamException
      * @see javax.xml.stream.XMLStreamReader#getTextCharacters(int, char[], int, int)
      */
@@ -349,7 +349,7 @@
     }
 
     /**
-     * @return
+     * @return Returns char[].
      * @see javax.xml.stream.XMLStreamReader#getTextCharacters()
      */
     public char[] getTextCharacters() {
@@ -367,7 +367,7 @@
     }
 
     /**
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getText()
      */
     public String getText() {
@@ -387,7 +387,7 @@
     }
 
     /**
-     * @return
+     * @return Returns int.
      * @see javax.xml.stream.XMLStreamReader#getEventType()
      */
 
@@ -398,7 +398,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getNamespaceURI
      */
     public String getNamespaceURI(int i) {
@@ -420,7 +420,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getNamespacePrefix
      */
     public String getNamespacePrefix(int i) {
@@ -441,7 +441,7 @@
     }
 
     /**
-     * @return
+     * @return Returns int.
      * @see javax.xml.stream.XMLStreamReader#getNamespaceCount()
      */
     public int getNamespaceCount() {
@@ -461,7 +461,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns boolean.
      * @see javax.xml.stream.XMLStreamReader#isAttributeSpecified
      */
     public boolean isAttributeSpecified(int i) {
@@ -482,7 +482,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getAttributeValue
      */
     public String getAttributeValue(int i) {
@@ -505,7 +505,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getAttributeType
      */
     public String getAttributeType(int i) {
@@ -526,7 +526,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getAttributePrefix
      */
     public String getAttributePrefix(int i) {
@@ -552,7 +552,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getAttributeLocalName
      */
     public String getAttributeLocalName(int i) {
@@ -579,7 +579,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns String.
      * @see javax.xml.stream.XMLStreamReader#getAttributeNamespace
      */
     public String getAttributeNamespace(int i) {
@@ -605,7 +605,7 @@
 
     /**
      * @param i
-     * @return
+     * @return Returns QName.
      * @see javax.xml.stream.XMLStreamReader#getAttributeName
      */
     public QName getAttributeName(int i) {
@@ -624,7 +624,7 @@
     }
 
     /**
-     * @return
+     * @return Returns int.
      * @see javax.xml.stream.XMLStreamReader#getAttributeCount
      */
     public int getAttributeCount() {
@@ -647,11 +647,11 @@
     // todo
 
     /**
-     * Method getAttributeValue
+     * Method getAttributeValue.
      *
      * @param s
      * @param s1
-     * @return
+     * @return Returns String.
      */
     public String getAttributeValue(String s, String s1) {
         String returnString = null;
@@ -673,9 +673,9 @@
     }
 
     /**
-     * Method isWhiteSpace
+     * Method isWhiteSpace.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isWhiteSpace() {
         boolean b;
@@ -688,9 +688,9 @@
     }
 
     /**
-     * Method isCharacters
+     * Method isCharacters.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isCharacters() {
         boolean b;
@@ -703,9 +703,9 @@
     }
 
     /**
-     * Method isEndElement
+     * Method isEndElement.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isEndElement() {
         boolean b;
@@ -729,9 +729,9 @@
     }
 
     /**
-     * Method isStartElement
+     * Method isStartElement.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isStartElement() {
         boolean b;
@@ -744,10 +744,10 @@
     }
 
     /**
-     * Method getNamespaceURI
+     * Method getNamespaceURI.
      *
      * @param s
-     * @return
+     * @return Returns String.
      */
     public String getNamespaceURI(String s) {
         String returnString = null;
@@ -764,7 +764,7 @@
     }
 
     /**
-     * Method close
+     * Method close.
      *
      * @throws XMLStreamException
      */
@@ -777,9 +777,9 @@
     }
 
     /**
-     * Method hasNext
+     * Method hasNext.
      *
-     * @return
+     * @return Returns boolean.
      * @throws XMLStreamException
      */
     public boolean hasNext() throws XMLStreamException {
@@ -793,7 +793,7 @@
     /**
      * Not implemented yet
      *
-     * @return
+     * @return Returns int.
      * @throws org.apache.axis2.om.impl.llom.exception.OMStreamingException
      *
      * @throws XMLStreamException
@@ -803,7 +803,7 @@
     }
 
     /**
-     * @return
+     * @return Returns String.
      * @throws XMLStreamException
      * @see javax.xml.stream.XMLStreamReader#getElementText()
      */
@@ -826,9 +826,9 @@
     }
 
     /**
-     * Method next
+     * Method next.
      *
-     * @return
+     * @return Returns int.
      * @throws XMLStreamException
      */
     public int next() throws XMLStreamException {
@@ -873,10 +873,10 @@
     }
 
     /**
-     * Method getProperty
+     * Method getProperty.
      *
      * @param s
-     * @return
+     * @return Returns Object.
      * @throws IllegalArgumentException
      */
     public Object getProperty(String s) throws IllegalArgumentException {
@@ -884,11 +884,10 @@
     }
 
     /**
-     * This is a very important method. this keeps the
-     * navigator one step ahead and pushes the navigator
-     * one event ahead. If the nextNode is null then navigable is set to false;
-     * At the same time the parser and builder are set up for the upcoming event
-     * generation
+     * This is a very important method. This keeps the navigator one step 
+     * ahead and pushes the navigator one event ahead. If the nextNode is null
+     * then navigable is set to false; At the same time the parser and builder 
+     * are set up for the upcoming event generation
      *
      * @throws XMLStreamException
      */
@@ -903,7 +902,7 @@
     }
 
     /**
-     * Method updateNextNode
+     * Method updateNextNode.
      */
     private void updateNextNode() {
         if (navigator.isNavigable()) {
@@ -929,7 +928,7 @@
     }
 
     /**
-     * Method updateCompleteStatus
+     * Method updateCompleteStatus.
      */
     private void updateCompleteStatus() {
         if (state == NAVIGABLE) {
@@ -948,36 +947,36 @@
     }
 
     /**
-     * Method getNamespaceContext
+     * Method getNamespaceContext.
      *
-     * @return
+     * @return Returns NamespaceContext.
      */
     public NamespaceContext getNamespaceContext() {
         throw new UnsupportedOperationException();
     }
 
     /**
-     * Method getEncoding
+     * Method getEncoding.
      *
-     * @return
+     * @return Returns String.
      */
     public String getEncoding() {
         return null;
     }
 
     /**
-     * Method getLocation
+     * Method getLocation.
      *
-     * @return
+     * @return Returns Location.
      */
     public Location getLocation() {
         throw new UnsupportedOperationException();
     }
 
     /**
-     * Method getVersion
+     * Method getVersion.
      *
-     * @return
+     * @return Returns String.
      */
     public String getVersion() {
         return "1.0"; //todo put the constant
@@ -985,45 +984,45 @@
 
 
     /**
-     * Method isStandalone
+     * Method isStandalone.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean isStandalone() {
         return true;
     }
 
     /**
-     * Method standaloneSet
+     * Method standaloneSet.
      *
-     * @return
+     * @return Returns boolean.
      */
     public boolean standaloneSet() {
         return false;
     }
 
     /**
-     * Method getCharacterEncodingScheme
+     * Method getCharacterEncodingScheme.
      *
-     * @return
+     * @return Returns String.
      */
     public String getCharacterEncodingScheme() {
         return "utf-8";
     }
 
     /**
-     * Method getPITarget
+     * Method getPITarget.
      *
-     * @return
+     * @return Returns String.
      */
     public String getPITarget() {
         throw new UnsupportedOperationException();
     }
 
     /**
-     * Method getPIData
+     * Method getPIData.
      *
-     * @return
+     * @return Returns String.
      */
     public String getPIData() {
         throw new UnsupportedOperationException();
@@ -1041,7 +1040,7 @@
      * Method generateEvents
      *
      * @param node
-     * @return
+     * @return Returns int.
      */
     private int generateEvents(OMNode node) {
         int returnEvent = 0;
@@ -1067,10 +1066,10 @@
     }
 
     /**
-     * Method generateElementEvents
+     * Method generateElementEvents.
      *
      * @param elt
-     * @return
+     * @return Returns int.
      */
     private int generateElementEvents(OMElement elt) {
         int returnValue = START_ELEMENT;
@@ -1084,27 +1083,27 @@
     }
 
     /**
-     * Method generateTextEvents
+     * Method generateTextEvents.
      *
-     * @return
+     * @return Returns int.
      */
     private int generateTextEvents() {
         return CHARACTERS;
     }
 
     /**
-     * Method generateCommentEvents
+     * Method generateCommentEvents.
      *
-     * @return
+     * @return Returns int.
      */
     private int generateCommentEvents() {
         return COMMENT;
     }
 
     /**
-     * Method generateCdataEvents
+     * Method generateCdataEvents.
      *
-     * @return
+     * @return Returns int.
      */
     private int generateCdataEvents() {
         return CDATA;
@@ -1117,10 +1116,10 @@
      */
 
     /**
-     * helper method
+     * helper method.
      *
      * @param it
-     * @return
+     * @return Returns int.
      */
     private int getCount(Iterator it) {
         int count = 0;
@@ -1134,11 +1133,11 @@
     }
 
     /**
-     * Helper method
+     * Helper method.
      *
      * @param it
      * @param index
-     * @return
+     * @return Returns Object.
      */
     private Object getItemFromIterator(Iterator it, int index) {
         int count = 0;
@@ -1161,10 +1160,10 @@
     }
 
     /**
-     * Helper method
+     * Helper method.
      *
      * @param element
-     * @return
+     * @return Returns QName.
      */
     private QName getQName(OMElement element) {
         QName returnName;
@@ -1187,7 +1186,7 @@
     /**
      * @param elt
      * @param index
-     * @return
+     * @return Returns OMAttribute.
      */
     private OMAttribute getAttribute(OMElement elt, int index) {
         OMAttribute returnAttrib = null;

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DocumentImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DocumentImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DocumentImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/DocumentImpl.java Wed Jan  4 16:09:34 2006
@@ -88,7 +88,7 @@
 	}	
 
 	///
-	///Override ChildNode specific methods
+	///Overrides ChildNode specific methods.
 	///
 	public OMNode getNextOMSibling() throws OMException {
 		throw new UnsupportedOperationException("This is the document node");
@@ -374,7 +374,7 @@
     }
 	
 	/**
-	 * Returns the document element
+	 * Returns the document element.
 	 * @see org.apache.axis2.om.OMDocument#getOMDocumentElement()
 	 */
 	public OMElement getOMDocumentElement() {
@@ -389,7 +389,7 @@
 	}
 	
 	/**
-	 * Returns the document element
+	 * Returns the document element.
 	 * @see org.w3c.dom.Document#getDocumentElement()
 	 */
 	public Element getDocumentElement() {
@@ -398,8 +398,7 @@
 	}
 	
     /**
-     * Borrowed from the Xerces impl
-     * 
+     * Borrowed from the Xerces impl.
      * Checks if the given qualified name is legal with respect
      * to the version of XML to which this document must conform.
      *

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ElementImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ElementImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ElementImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ElementImpl.java Wed Jan  4 16:09:34 2006
@@ -73,7 +73,7 @@
 	}
 	
 	/**
-	 * Create a  new element with the namespace
+	 * Creates a  new element with the namespace.
 	 * @param ownerDocument
 	 * @param tagName
 	 * @param ns
@@ -152,7 +152,7 @@
 	}
 
 	/**
-	 * Returns the value of the namespace URI
+	 * Returns the value of the namespace URI.
 	 */
 	public String getNamespaceURI() {
 		return (this.namespace != null)?this.namespace.getName(): null;
@@ -227,7 +227,7 @@
 	}
 
 	/**
-	 * Removes the specified attribute node
+	 * Removes the specified attribute node.
 	 * @see org.w3c.dom.Element#removeAttributeNode(org.w3c.dom.Attr)
 	 */
 	public Attr removeAttributeNode(Attr oldAttr) throws DOMException {
@@ -251,7 +251,7 @@
 	}
 
 	/**
-	 * Returns whether the  given attr is available or not
+	 * Returns whether the given attribute is available or not.
 	 * @see org.w3c.dom.Element#hasAttributeNS(java.lang.String, java.lang.String)
 	 */
 	public boolean hasAttributeNS(String namespaceURI, String localName) {
@@ -259,8 +259,8 @@
 	}
 	
 	/**
-	 * Look in the local list of attributes and return if found
-	 * if the local list is null return null
+	 * Looks in the local list of attributes and returns if found.
+	 * If the local list is null, returns "".
 	 * @see org.w3c.dom.Element#getAttribute(java.lang.String)
 	 */
 	public String getAttribute(String name) {
@@ -293,7 +293,7 @@
 	}
 
 	/**
-	 * Retrieves an Attr node by local name and namespace URI. 
+	 * Retrieves an attribute node by local name and namespace URI. 
 	 * @see org.w3c.dom.Element#getAttributeNodeNS(java.lang.String, java.lang.String)
 	 */
 	public Attr getAttributeNodeNS(String namespaceURI, String localName) {
@@ -412,7 +412,7 @@
 	}
 	
 	/**
-	 * Adds a new attribute
+	 * Adds a new attribute.
 	 * @see org.w3c.dom.Element#setAttributeNS(java.lang.String, java.lang.String, java.lang.String)
 	 */
 	public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException {
@@ -485,7 +485,7 @@
 	}
 
 	/**
-	 * Returns whether this element contains any attr or not
+	 * Returns whether this element contains any attribute or not.
 	 */
     public boolean hasAttributes() {
     	
@@ -557,8 +557,7 @@
 	}
 
 	/**
-	 * This will allow overriding an existing declaration if the same 
-	 * prefix was used 
+	 * Allows overriding an existing declaration if the same prefix was used.
 	 * @see org.apache.axis2.om.OMElement#declareNamespace(org.apache.axis2.om.OMNamespace)
 	 */
 	public OMNamespace declareNamespace(OMNamespace namespace) {
@@ -574,8 +573,7 @@
 	}
 
 	/**
-	 * This will allow overriding an existing declaration
-	 * if the same prefix was used 
+	 * Allows overriding an existing declaration if the same prefix was used.
 	 * @see org.apache.axis2.om.OMElement#declareNamespace(java.lang.String, java.lang.String)
 	 */
 	public OMNamespace declareNamespace(String uri, String prefix) {
@@ -623,9 +621,8 @@
     }
 
     /**
-     * This will ckeck for the namespace <B>only</B> in the current Element.
-     * <p/>
-     * This can also be used to retrieve the prefix of a known namespace URI
+     * Checks for the namespace <B>only</B> in the current Element.
+     * This can also be used to retrieve the prefix of a known namespace URI.
      */
     private OMNamespace findDeclaredNamespace(String uri, String prefix) {
     	
@@ -679,10 +676,10 @@
 	}
 
    /**
-    * Return a named attribute's value, if present.
+    * Returns a named attribute's value, if present.
     *
     * @param qname the qualified name to search for
-    * @return a String containing the attribute value, or null
+    * @return Returns a String containing the attribute value, or null.
     */
    public String getAttributeValue(QName qname) {
        OMAttribute attr = getAttribute(qname);
@@ -696,7 +693,7 @@
 	}
 
 	/**
-	 * Returns the first Element node
+	 * Returns the first Element node.
 	 * @see org.apache.axis2.om.OMElement#getFirstElement()
 	 */
 	public OMElement getFirstElement() {
@@ -712,7 +709,7 @@
 	}
 
 	/**
-	 * Returns the namespace of this element
+	 * Returns the namespace of this element.
 	 * @see org.apache.axis2.om.OMElement#getNamespace()
 	 */
 	public OMNamespace getNamespace() throws OMException {
@@ -720,7 +717,7 @@
 	}
 
 	/**
-	 * Returns the QName of this element
+	 * Returns the QName of this element.
 	 * @see org.apache.axis2.om.OMElement#getQName()
 	 */
 	public QName getQName() {
@@ -740,7 +737,7 @@
 
 
     /**
-	 * select all the text children and concat them to a single string
+	 * Gets all the text children and concatinates them to a single string.
 	 * @see org.apache.axis2.om.OMElement#getText()
 	 */
 	public String getText() {
@@ -763,7 +760,7 @@
 	}
 
 	/**
-	 * Removes an attribute fron the element
+	 * Removes an attribute from the element.
 	 * 
 	 * @see org.apache.axis2.om.OMElement#removeAttribute(org.apache.axis2.om.OMAttribute)
 	 */
@@ -772,7 +769,7 @@
 	}
 
 	/**
-	 * Sets the OM builder
+	 * Sets the OM builder.
 	 * @see org.apache.axis2.om.OMElement#setBuilder(org.apache.axis2.om.OMXMLParserWrapper)
 	 */
 	public void setBuilder(OMXMLParserWrapper wrapper) {
@@ -780,7 +777,7 @@
 	}
 
 	/**
-	 * Set the local name
+	 * Sets the local name.
 	 * @see org.apache.axis2.om.OMElement#setLocalName(java.lang.String)
 	 */
 	public void setLocalName(String localName) {
@@ -788,7 +785,7 @@
 	}
 
 	/**
-	 * Set the namespace
+	 * Sets the namespace.
 	 * @see org.apache.axis2.om.OMElement#setNamespace(org.apache.axis2.om.OMNamespace)
 	 */
 	public void setNamespace(OMNamespace namespace) {
@@ -796,8 +793,7 @@
 	}
 
 	/**
-	 * Creates a text node with the given value and adds it to the 
-	 * element
+	 * Creates a text node with the given value and adds it to the element.
 	 * @see org.apache.axis2.om.OMElement#setText(java.lang.String)
 	 */
 	public void setText(String text) {
@@ -889,7 +885,7 @@
     /**
      * getXMLStreamReader
      *
-     * @return reader
+     * @return Returns reader.
      */
     private XMLStreamReader getXMLStreamReader(boolean cache) {
         if ((builder == null) && !cache) {
@@ -911,7 +907,7 @@
     }
     
     /**
-     * Overridden toString() for ease of debuging
+     * Overridden toString() for ease of debugging.
      * @see java.lang.Object#toString()
      */
     public String toString() {
@@ -959,7 +955,7 @@
     }
     
     /**
-     * returns the namespace prefix of this element node
+     * Returns the namespace prefix of this element node
      * @see org.w3c.dom.Node#getPrefix()
      */
     public String getPrefix()
@@ -983,7 +979,7 @@
      * unprefixed qnames resolve to the local namespace
      *
      * @param qname prefixed qname string to resolve
-     * @return null for any failure to extract a qname.
+     * @return Returns null for any failure to extract a qname.
      */
     public QName resolveQName(String qname) {
         ElementHelper helper = new ElementHelper(this);
@@ -991,7 +987,7 @@
     }
 
     /**
-     * This will create a clone which belongs to a new document 
+     * Creates a clone which belongs to a new document.
      * @see org.apache.axis2.om.OMElement#cloneOMElement()
      */
     public OMElement cloneOMElement() {
@@ -1011,8 +1007,8 @@
     }
     
     /**
-     * This will return the set of attributes of this node and the 
-     * namespace declarations available
+     * Returns the set of attributes of this node and the namespace 
+     * declarations available.
      */
     public NamedNodeMap getAttributes() {
     	AttributeMap attributeMap =  new AttributeMap(this);
@@ -1058,11 +1054,10 @@
     }
     
     /**
-     * return the namespace uri, given the prefix
-     * if its not found at the this element it will 
-     * search the parent
+     * Returns the namespace uri, given the prefix. If it is not found at this 
+     * element, searches the parent.
      * @param prefix
-     * @return namespace
+     * @return Returns namespace.
      */
     public String getNamespaceURI(String prefix) {
     	OMNamespace ns = this.findNamespaceURI(prefix);
@@ -1070,9 +1065,9 @@
     }
     
     /**
-     * Remove a declared namespace give its prefix
+     * Removes a declared namespace given its prefix.
      * @param prefix
-     * @return whether the namespace relevant to the 
+     * @return Returns whether the namespace relevant to the 
      * given prefix was removed or not
      */
     public boolean removeNamespace(String prefix) {
@@ -1127,4 +1122,4 @@
 		// TODO TODO
 		throw new UnsupportedOperationException("TODO");
 	}
-}
\ No newline at end of file
+}

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NamedNodeMapImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NamedNodeMapImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NamedNodeMapImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NamedNodeMapImpl.java Wed Jan  4 16:09:34 2006
@@ -24,7 +24,7 @@
 /**
  * 
  * Most of the implementation is taken from 
- * From org.apache.xerces.dom.NamedNodeMapImpl
+ * org.apache.xerces.dom.NamedNodeMapImpl
  */
 public class NamedNodeMapImpl implements NamedNodeMap {
 
@@ -72,7 +72,7 @@
     /**
      * Removes a node specified by name.
      * @param name The name of a node to remove.
-     * @return The node removed from the map if a node with such a name exists.
+     * @return Returns the node removed from the map if a node with such a name exists.
      */
     /***/
     public Node removeNamedItem(String name)
@@ -99,14 +99,14 @@
     
     
     /**
-     * Introduced in DOM Level 2. <p>
+     * Introduced in DOM Level 2. 
      * Retrieves a node specified by local name and namespace URI.
      *
      * @param namespaceURI  The namespace URI of the node to retrieve.
      *                      When it is null or an empty string, this
      *                      method behaves like getNamedItem.
      * @param localName     The local name of the node to retrieve.
-     * @return Node         A Node (of any type) with the specified name, or null if the specified
+     * @return          Returns s Node (of any type) with the specified name, or null if the specified
      *                      name did not identify any node in the map.
      */
     public Node getNamedItemNS(String namespaceURI, String localName) {
@@ -119,8 +119,7 @@
     /**
      * Adds a node using its namespaceURI and localName.
      * @see org.w3c.dom.NamedNodeMap#setNamedItem
-     * @return If the new Node replaces an existing node the replaced Node is returned,
-     *      otherwise null is returned. 
+     * @return Returns the replaced Node if the new Node replaces an existing node else returns null.
      * @param arg A node to store in a named node map. The node will later be
      *      accessible using the value of the namespaceURI and localName
      *      attribute of the node. If a node with those namespace URI and
@@ -169,14 +168,14 @@
     } // setNamedItemNS(Node):Node
 
     /**
-     * Introduced in DOM Level 2. <p>
+     * Introduced in DOM Level 2. 
      * Removes a node specified by local name and namespace URI.
      * @param namespaceURI
      *                      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.
-     * @return Node         The node removed from the map if a node with such
+     * @return          Returns 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
      *                      name in the map.
@@ -212,8 +211,8 @@
       * value) cannot be stored as the names would clash. This is seen as preferable to
       * allowing nodes to be aliased.
       * @see org.w3c.dom.NamedNodeMap#setNamedItem
-      * @return If the new Node replaces an existing node the replaced Node is returned,
-      *      otherwise null is returned. 
+      * @return Returns the replaced Node if the new Node replaces an existing node, 
+      *         otherwise returns null.
       * @param arg 
       *      A node to store in a named node map. The node will later be
       *      accessible using the value of the namespaceURI and localName
@@ -285,7 +284,7 @@
      * 
      * From org.apache.xerces.dom.NamedNodeMapImpl
      * 
-     * Subroutine: Locate the named item, or the point at which said item
+     * Subroutine: Locates the named item, or the point at which said item
      * should be added. 
      *
      * @param name Name of a node to look up.
@@ -362,7 +361,7 @@
         return -1;
     }
     
-    // compare 2 nodes in the map.  If a precedes b, return true, otherwise 
+    // Compare 2 nodes in the map.  If a precedes b, return true, otherwise 
     // return false
     protected boolean precedes(Node a, Node b) {
 
@@ -379,7 +378,7 @@
 
 
     /**
-      * NON-DOM: Remove attribute at specified index
+      * NON-DOM: Remove attribute at specified index.
       */
     protected void removeItem(int index) {
        if (nodes != null && index < nodes.size()){
@@ -422,7 +421,7 @@
      * NON-DOM: copy content of this map into the specified vector
      * 
      * @param list   Vector to copy information into.
-     * @return A copy of this node named map
+     * @return Returns a copy of this node named map.
      */
     protected Vector cloneMap(Vector list){
         if (list == null) {
@@ -443,7 +442,7 @@
      }
 
     /**
-      * NON-DOM remove all elements from this map
+      * NON-DOM remove all elements from this map.
       */
     public void removeAll (){
         if (nodes != null) {

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeImpl.java Wed Jan  4 16:09:34 2006
@@ -119,7 +119,7 @@
 
 
     /*
-      * Overidden in ElementImpl and AttrImpl
+      * Overidden in ElementImpl and AttrImpl.
       */
     public String getPrefix() {
         return null;
@@ -137,7 +137,7 @@
     }
 
     /**
-     * Find the Document that this Node belongs to (the document in
+     * Finds the document that this Node belongs to (the document in
      * whose context the Node was created). The Node may or may not
      */
     public Document getOwnerDocument() {
@@ -145,7 +145,7 @@
     }
 
     /**
-     * Return the collection of attributes associated with this node,
+     * Returns the collection of attributes associated with this node,
      * or null if none. At this writing, Element is the only type of node
      * which will ever have attributes.
      *
@@ -155,7 +155,7 @@
         return null; // overridden in ElementImpl
     }
 
-    /** The first child of this Node, or null if none.
+    /** Gets the first child of this Node, or null if none.
      * <P>
      * By default we do not have any children, ParentNode overrides this.
      * @see ParentNode
@@ -165,7 +165,7 @@
     }
 
 
-    /** The first child of this Node, or null if none.
+    /** Gets the last child of this Node, or null if none.
      * <P>
      * By default we do not have any children, ParentNode overrides this.
      * @see ParentNode
@@ -174,7 +174,7 @@
         return null;
     }
 
-    /** The next child of this node's parent, or null if none */
+    /** Returns the next child of this node's parent, or null if none. */
     public Node getNextSibling() {
         return null;            // default behavior, overriden in ChildNode
     }
@@ -186,13 +186,13 @@
     }
 
     /*
-     * same as above but returns internal type
+     * Same as getParentNode but returns internal type NodeImpl.
      */
     NodeImpl parentNode() {
         return null;
     }
 
-    /** The previous child of this node's parent, or null if none */
+    /** Returns the previous child of this node's parent, or null if none. */
     public Node getPreviousSibling() {
         return null;            // default behavior, overriden in ChildNode
     }
@@ -293,25 +293,25 @@
     //
 
     /**
-     * NodeList method: Count the immediate children of this node
+     * NodeList method: Returns the number of immediate children of this node.
      * <P>
      * By default we do not have any children, ParentNode overrides this.
      * @see ParentNode
      *
-     * @return int
+     * @return Returns int.
      */
     public int getLength() {
         return 0;
     }
 
     /**
-     * NodeList method: Return the Nth immediate child of this node, or
+     * NodeList method: Returns the Nth immediate child of this node, or
      * null if the index is out of bounds.
      * <P>
      * By default we do not have any children, ParentNode overrides this.
      * @see ParentNode
      *
-     * @return org.w3c.dom.Node
+     * @return Returns org.w3c.dom.Node
      * @param index
      */
     public Node item(int index) {
@@ -395,7 +395,7 @@
     }
 
     /**
-     * There no concept of caching in this OM-DOM implementation
+     * There no concept of caching in this OM-DOM implementation.
      */
     public void serializeWithCache(OMOutputImpl omOutput) throws XMLStreamException {
         this.serialize(omOutput);
@@ -428,14 +428,14 @@
 
 
     /**
-     * default behavior, overriden in ChildNode
+     * Default behavior returns null, overriden in ChildNode.
      */
     public OMNode getPreviousOMSibling() {
         return null;
     }
 
     /**
-     * default behavior, overriden in ChildNode
+     * Default behavior returns null, overriden in ChildNode.
      */
     public OMNode getNextOMSibling() {
         return null;
@@ -456,7 +456,7 @@
     }
 
     /**
-     * Build next element
+     * Builds next element.
      */
     public void build() {
         while (!done)
@@ -464,7 +464,7 @@
     }
 
     /**
-     * sets the owner document
+     * Sets the owner document.
      * @param document
      */
     protected void setOwnerDocument(DocumentImpl document) {

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeListImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeListImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeListImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/NodeListImpl.java Wed Jan  4 16:09:34 2006
@@ -55,7 +55,7 @@
     }
 
 	/**
-	 * Returns the numbre of nodes
+	 * Returns the number of nodes.
 	 * @see org.w3c.dom.NodeList#getLength()
 	 */
 	public int getLength() {
@@ -81,7 +81,7 @@
 
 	/**
 	 * Returns the node at the given index.
-	 * returns null if the index is invalid. 
+	 * Returns null if the index is invalid. 
 	 * @see org.w3c.dom.NodeList#item(int)
 	 */
 	public Node item(int index) {

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ParentNode.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ParentNode.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ParentNode.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/ParentNode.java Wed Jan  4 16:09:34 2006
@@ -69,7 +69,7 @@
 	}
 	
 	/**
-	 * Returns an iterator of child nodes having a given qname
+	 * Returns an iterator of child nodes having a given qname.
 	 * @see org.apache.axis2.om.OMContainer#getChildrenWithName(javax.xml.namespace.QName)
 	 */
 	public Iterator getChildrenWithName(QName elementQName) throws OMException {
@@ -78,7 +78,7 @@
 	}
 	
 	/**
-	 * Return the first OMElement child node
+	 * Returns the first OMElement child node.
 	 * @see org.apache.axis2.om.OMContainer#getFirstChildWithName(javax.xml.namespace.QName)
 	 */
 	public OMElement getFirstChildWithName(QName elementQName)
@@ -141,8 +141,8 @@
 	}
 	
 	/**
-	 * Inserts newChild before the refChild
-	 * If the refChild is null then the newChild is nade the last child  
+	 * Inserts newChild before the refChild.
+	 * If the refChild is null then the newChild is made the last child.  
 	 */
 	public Node insertBefore(Node newChild, Node refChild) throws DOMException {
 	
@@ -276,7 +276,7 @@
 	}
 	
 	/**
-	 * Replaces the oldChild with the newChild
+	 * Replaces the oldChild with the newChild.
 	 */
 	public Node replaceChild(Node newChild, Node oldChild) throws DOMException {
 		ChildNode newDomChild = (ChildNode)newChild;
@@ -356,7 +356,7 @@
 	
 	
 	/**
-	 * Removes the given child from the DOM Tree
+	 * Removes the given child from the DOM Tree.
 	 */
 	public Node removeChild(Node oldChild) throws DOMException {
 		//Check if this node is readonly

Modified: webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/TextImpl.java
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/TextImpl.java?rev=366034&r1=366033&r2=366034&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/TextImpl.java (original)
+++ webservices/axis2/trunk/java/modules/doom/src/org/apache/axis2/om/impl/dom/TextImpl.java Wed Jan  4 16:09:34 2006
@@ -46,42 +46,38 @@
 	private boolean isBinary;
 
     /**
-     * Field dataHandler contains the DataHandler
-     * Declaring as Object to remove the depedency on 
-     * Javax.activation.DataHandler
+     *
      */
     private String contentID = null;
 
     /**
-     * Field dataHandler contains the DataHandler
-     * Declaring as Object to remove the depedency on 
+     * Field dataHandler contains the DataHandler.
+     * Declaring as Object to remove the dependency on 
      * Javax.activation.DataHandler
      */
     private Object dataHandlerObject = null;
 
     
     /**
-     * Field nameSpace used when serialising Binary stuff as MTOM optimised
+     * Field nameSpace is used when serializing Binary stuff as MTOM optimized.
      */
     protected OMNamespace ns = new NamespaceImpl(
             "http://www.w3.org/2004/08/xop/include", "xop");
 
     /**
-     * Field localName used when serialising Binary stuff as MTOM optimised
+     * Field localName is used when serializing Binary stuff as MTOM optimized.
      */
     protected String localName = "Include";
 
     /**
-     * Field attributes used when serialising Binary stuff as MTOM optimised
+     * Field attribute is used when serializing Binary stuff as MTOM optimized.
      */
     protected OMAttribute attribute;
     
     
 	/**
-	 * Create a text node with the given text
-	 * required by the OMDOMFactory
-	 * The owner document should be set properly when
-	 * appending this to a DOM tree
+	 * Creates a text node with the given text required by the OMDOMFactory.
+	 * The owner document should be set properly when appending this to a DOM tree.
 	 * @param text
 	 */
 	public TextImpl(String text) {
@@ -257,7 +253,7 @@
     }
     
     /**
-     * Writes the relevant output
+     * Writes the relevant output.
      *
      * @param omOutput
      * @throws XMLStreamException
@@ -376,7 +372,7 @@
     
 
     /*
-     * Methods to copy from OMSerialize utils
+     * Methods to copy from OMSerialize utils.
      */
     private void serializeStartpart(OMOutputImpl omOutput)
             throws XMLStreamException {
@@ -420,7 +416,7 @@
     }
 
     /**
-     * Method serializeAttribute
+     * Method serializeAttribute.
      *
      * @param attr
      * @param omOutput
@@ -450,7 +446,7 @@
     }
 
     /**
-     * Method serializeNamespace
+     * Method serializeNamespace.
      *
      * @param namespace
      * @param omOutput



Mime
View raw message