mmidy 00/12/13 14:59:43
Modified: java/src/org/apache/xml/utils NSInfo.java UnImplNode.java
URI.java
Log:
Javadoc updates
Revision Changes Path
1.2 +20 -14 xml-xalan/java/src/org/apache/xml/utils/NSInfo.java
Index: NSInfo.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/NSInfo.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- NSInfo.java 2000/11/23 04:58:45 1.1
+++ NSInfo.java 2000/12/13 22:59:42 1.2
@@ -69,8 +69,10 @@
* Constructor NSInfo
*
*
- * NEEDSDOC @param hasProcessedNS
- * NEEDSDOC @param hasXMLNSAttrs
+ * @param hasProcessedNS Flag indicating whether namespaces
+ * have been processed for this node
+ * @param hasXMLNSAttrs Flag indicating whether this node
+ * has XMLNS attributes.
*/
public NSInfo(boolean hasProcessedNS, boolean hasXMLNSAttrs)
{
@@ -87,9 +89,12 @@
* Constructor NSInfo
*
*
- * NEEDSDOC @param hasProcessedNS
- * NEEDSDOC @param hasXMLNSAttrs
- * NEEDSDOC @param ancestorHasXMLNSAttrs
+ * @param hasProcessedNS Flag indicating whether namespaces
+ * have been processed for this node
+ * @param hasXMLNSAttrs Flag indicating whether this node
+ * has XMLNS attributes.
+ * @param hasXMLNSAttrs Flag indicating whether one of this node's
+ * ancestor has XMLNS attributes.
*/
public NSInfo(boolean hasProcessedNS, boolean hasXMLNSAttrs,
int ancestorHasXMLNSAttrs)
@@ -105,8 +110,9 @@
* Constructor NSInfo
*
*
- * NEEDSDOC @param namespace
- * NEEDSDOC @param hasXMLNSAttrs
+ * @param namespace The namespace URI
+ * @param hasXMLNSAttrs Flag indicating whether this node
+ * has XMLNS attributes.
*/
public NSInfo(String namespace, boolean hasXMLNSAttrs)
{
@@ -117,24 +123,24 @@
m_ancestorHasXMLNSAttrs = ANCESTORXMLNSUNPROCESSED;
}
- /** NEEDSDOC Field m_namespace */
+ /** The namespace URI */
public String m_namespace;
- /** NEEDSDOC Field m_hasXMLNSAttrs */
+ /** Flag indicating whether this node has an XMLNS attribute */
public boolean m_hasXMLNSAttrs;
- /** NEEDSDOC Field m_hasProcessedNS */
+ /** Flag indicating whether namespaces have been processed for this node */
public boolean m_hasProcessedNS;
- /** NEEDSDOC Field m_ancestorHasXMLNSAttrs */
+ /** Flag indicating whether one of this node's ancestor has an XMLNS
attribute */
public int m_ancestorHasXMLNSAttrs;
- /** NEEDSDOC Field ANCESTORXMLNSUNPROCESSED */
+ /** Constant for ancestors XMLNS atributes not processed */
public static final int ANCESTORXMLNSUNPROCESSED = 0;
- /** NEEDSDOC Field ANCESTORHASXMLNS */
+ /** Constant indicating an ancestor has an XMLNS attribute */
public static final int ANCESTORHASXMLNS = 1;
- /** NEEDSDOC Field ANCESTORNOXMLNS */
+ /** Constant indicating ancestors don't have an XMLNS attribute
*/
public static final int ANCESTORNOXMLNS = 2;
}
1.3 +26 -23 xml-xalan/java/src/org/apache/xml/utils/UnImplNode.java
Index: UnImplNode.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/UnImplNode.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- UnImplNode.java 2000/12/01 20:30:15 1.2
+++ UnImplNode.java 2000/12/13 22:59:42 1.3
@@ -587,7 +587,7 @@
/**
* Unimplemented. See org.w3c.dom.Node
*
- * NEEDSDOC @param value
+ * @return value Node value
*
* @throws DOMException
*/
@@ -613,7 +613,7 @@
/**
* Returns the name of this attribute.
*
- * NEEDSDOC ($objectName$) @return
+ * @return the name of this attribute.
*/
// public String getName()
@@ -955,8 +955,11 @@
/**
* Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param importedNode
- * NEEDSDOC @param deep
+ * @param importedNodeThe node to import.
+ * @param deepIf <code>true</code>, recursively import the subtree under
+ * the specified node; if <code>false</code>, import only the node
+ * itself, as explained above. This has no effect on <code>Attr</code>
+ * , <code>EntityReference</code>, and <code>Notation</code> nodes.
*
* @return null
*
@@ -973,8 +976,8 @@
/**
* Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param qualifiedName
+ * @param namespaceURI Namespace URI for the element
+ * @param qualifiedName Qualified name of the element
*
* @return null
*
@@ -992,8 +995,8 @@
/**
* Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param namespaceURI
- * NEEDSDOC @param qualifiedName
+ * @param namespaceURI Namespace URI of the attribute
+ * @param qualifiedName Qualified name of the attribute
*
* @return null
*
@@ -1011,7 +1014,7 @@
/**
* Unimplemented. See org.w3c.dom.Document
*
- * NEEDSDOC @param elementId
+ * @param elementId ID of the element to get
*
* @return null
*/
@@ -1024,10 +1027,10 @@
}
/**
- * NEEDSDOC Method setData
+ * Set Node data
*
*
- * NEEDSDOC @param data
+ * @param data data to set for this node
*
* @throws DOMException
*/
@@ -1039,8 +1042,8 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param count
+ * @param offset Start offset of substring to extract.
+ * @param count The length of the substring to extract.
*
* @return null
*
@@ -1057,7 +1060,7 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param arg
+ * @param arg String data to append
*
* @throws DOMException
*/
@@ -1069,8 +1072,8 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param arg
+ * @param offset Start offset of substring to insert.
+ * @param count The length of the substring to insert.
*
* @throws DOMException
*/
@@ -1082,8 +1085,8 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param count
+ * @param offset Start offset of substring to delete.
+ * @param count The length of the substring to delete.
*
* @throws DOMException
*/
@@ -1095,9 +1098,9 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param offset
- * NEEDSDOC @param count
- * NEEDSDOC @param arg
+ * @param offset Start offset of substring to replace.
+ * @param count The length of the substring to replace.
+ * @param arg substring to replace with
*
* @throws DOMException
*/
@@ -1110,9 +1113,9 @@
/**
* Unimplemented.
*
- * NEEDSDOC @param offset
+ * @param offset Offset into text to split
*
- * @return null
+ * @return null, unimplemented
*
* @throws DOMException
*/
1.3 +2 -2 xml-xalan/java/src/org/apache/xml/utils/URI.java
Index: URI.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xml/utils/URI.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- URI.java 2000/12/01 20:30:14 1.2
+++ URI.java 2000/12/13 22:59:42 1.3
@@ -88,7 +88,7 @@
* default port for a specific scheme). Rather, it only knows the
* grammar and basic set of operations that can be applied to a URI.
*
- * @version $Id: URI.java,v 1.2 2000/12/01 20:30:14 mmidy Exp $
+ * @version $Id: URI.java,v 1.3 2000/12/13 22:59:42 mmidy Exp $
*
*/
public class URI implements Serializable
@@ -166,7 +166,7 @@
/** If specified, stores the fragment for this URI; otherwise null */
private String m_fragment = null;
- /** NEEDSDOC Field DEBUG */
+ /** Indicate whether in DEBUG mode */
private static boolean DEBUG = false;
/**
