[bugfix] Add missing JavaDoc to address errors reported by 'mvn javadoc:javadoc'

Author: adamretter

java5/src/main/java/javax/xml/XMLConstants.java

@@ -54,9 +54,9 @@ public class XMLConstants {
   public static final java.lang.String XML_NS_URI =
       "http://www.w3.org/XML/1998/namespace";
 
-  /** <p>Constant holding the attribute name for declaration
-   * of new prefixes. The constant value is "xmlns".</p>
-   * <p><em>Note</em>: This is both an attribute name
+  /** Constant holding the attribute name for declaration
+   * of new prefixes. The constant value is "xmlns".
+   * <em>Note</em>: This is both an attribute name
    * and a namespace prefix: For example, to assign the empty
    * prefix to a namespace, one would use
    * <pre>
@@ -66,7 +66,7 @@ public class XMLConstants {
    * one would use
    * <pre>
    *   xmlns:pre="http://my.namespace/..."
-   * </pre></p>
+   * </pre>
    */
   public static final java.lang.String XMLNS_ATTRIBUTE = "xmlns";
 

java5/src/main/java/javax/xml/namespace/NamespaceContext.java

@@ -37,9 +37,9 @@
  * @since JAXB 1.0
  */
 public interface NamespaceContext {
-  /** <p>Given a prefix, returns the namespace URI associated with the prefix.
+  /** Given a prefix, returns the namespace URI associated with the prefix.
    * More precisely, the following rules apply:
-   * <table border="1">
+   * <table border="1" summary="Rules governing Prefix to URI lookup">
    *   <tr><th>Prefix (Input)</th><th>Namespace URI (Output)</th></tr>
    *   <tr><th>{@link javax.xml.XMLConstants#DEFAULT_NS_PREFIX} ("")</th>
    *     <td>The current default namespace URI or null, if there is no
@@ -52,7 +52,7 @@ public interface NamespaceContext {
    *   </tr>
    *   <tr><th>Any other prefix</th><td>The namespace URI currently mapped to the
    *     prefix or null, if no such mapping is established.</td></tr>
-   * </table></p>
+   * </table>
    * @param pPrefix The prefix being looked up in the list of mappings.
    * @return The Namespace URI to which the input prefix is currently mapped
    *   or null, if there is no such mapping.
@@ -61,20 +61,20 @@ public interface NamespaceContext {
   public String getNamespaceURI(String pPrefix);
 
 
-  /** <p>This method returns a prefix, which is currently mapped to the given
+  /** This method returns a prefix, which is currently mapped to the given
    * namespace URI. Note, that multiple prefixes may be mapped to the namespace
    * URI, in which case the returned prefix is undetermined. Do not make any
    * assumptions on the order in such cases. It is a better choice to use
    * {@link #getPrefixes(String)} instead, if you depend on some order
-   * <table border="1">
+   * <table border="1" summary="Rules governing URI to Prefix lookup">
    *   <tr><th>Namespace URI (Input)</th><th>Prefix (Output)</th></tr>
    *   <tr><th>Current default namespace URI</th>
    *     <td>{@link javax.xml.XMLConstants#DEFAULT_NS_PREFIX} ("")</td></tr>
    *   <tr><th>{@link javax.xml.XMLConstants#XML_NS_URI} ("http://www.w3.org/XML/1998/namespace")</th>
    *     <td>{@link javax.xml.XMLConstants#XML_NS_PREFIX} ("xml")</td></tr>
    *   <tr><th>{@link javax.xml.XMLConstants#XMLNS_ATTRIBUTE_NS_URI} ("http://www.w3.org/2000/xmlns/")</th>
    *     <td>{@link javax.xml.XMLConstants#XMLNS_ATTRIBUTE}</td></tr>
-   * </table></p>
+   * </table>
    *
    * @param pNamespaceURI The namespace URI being looked up in the list of mappings.
    * @return A prefix currently mapped to the given namespace URI or null, if there
@@ -84,19 +84,19 @@ public interface NamespaceContext {
   public java.lang.String getPrefix(java.lang.String pNamespaceURI);
 
 
-  /** <p>This method returns a collection of prefixes, which are currently mapped
+  /** This method returns a collection of prefixes, which are currently mapped
    * to the given namespace URI. Note, that the collection may contain more than
    * one prefix, in which case the order is undetermined. If you do not depend
    * on a certain order and any prefix will do, you may choose to use
    * {@link #getPrefix(String)} instead. The following table describes the
    * returned values in more details:
-   * <table border="1">
+   * <table border="1" summary="Rules governing URI to Prefixes lookup">
    *   <tr><th>Namespace URI (Input)</th><th>Prefix collection (Output)</th></tr>
    *   <tr><th>{@link javax.xml.XMLConstants#XML_NS_URI} ("http://www.w3.org/XML/1998/namespace")</th>
    *     <td>Collection with a single element: {@link javax.xml.XMLConstants#XML_NS_PREFIX} ("xml")</td></tr>
    *   <tr><th>{@link javax.xml.XMLConstants#XMLNS_ATTRIBUTE_NS_URI} ("http://www.w3.org/2000/xmlns/")</th>
    *     <td>Collection with a single element: {@link javax.xml.XMLConstants#XMLNS_ATTRIBUTE}</td></tr>
-   * </table></p>
+   * </table>
    *
    * @param pNamespaceURI The namespace URI being looked up in the list of
    *   mappings or null, if there is no such mapping.

java5/src/main/java/javax/xml/namespace/QName.java

@@ -113,13 +113,13 @@ public String getPrefix() {
 		return prefix;
 	}
 
-	/** <p>Returns true, if
+	/** Returns true, if
 	 * <ul>
 	 *   <li><code>pOther</code> instanceof QName</li>
 	 *   <li>getNamespaceURI().equals(pOther.getNamespaceURI())</li>
 	 *   <li>getLocalPart().equals(pOther.getLocalPart())</li>
 	 * </ul>
-	 * <em>Note</em>: The prefix is ignored.</p>
+	 * <em>Note</em>: The prefix is ignored.
 	 */
 	public boolean equals(Object pOther) {
 		if (!(pOther instanceof QName)) {

util/src/main/java/org/apache/ws/commons/util/NamespaceContextImpl.java

@@ -49,7 +49,9 @@ public void reset() {
     }
 
 	/** Declares a new prefix. Typically called from within
-	 * {@link org.xml.sax.ContextHandler#startPrefixMapping(java.lang.String, java.lang.String)}.
+	 * {@link org.xml.sax.ContentHandler#startPrefixMapping(String, String)}.
+     * @param pPrefix The namespace prefix.
+     * @param pURI The namespace URI.
 	 * @throws IllegalArgumentException Prefix or URI are null.
      */
     public void startPrefixMapping(String pPrefix, String pURI) {
@@ -70,7 +72,8 @@ public void startPrefixMapping(String pPrefix, String pURI) {
 
 	/** Removes the declaration of the prefix, which has been defined
 	 * last. Typically called from within
-	 * {@link org.xml.sax.ContextHandler#endPrefixMapping(java.lang.String)}.
+	 * {@link org.xml.sax.ContentHandler#endPrefixMapping(String)}.
+     * @param pPrefix The namespace prefix.
 	 * @throws IllegalArgumentException The prefix is null.
 	 * @throws IllegalStateException The prefix is not the prefix, which
 	 * has been defined last. In other words, the calls to
@@ -94,10 +97,10 @@ public void endPrefixMapping(String pPrefix) {
         }
     }
 
-    /** Given a prefix, returns the URI to which the prefix is
+    /** <p>Given a prefix, returns the URI to which the prefix is
      * currently mapped or null, if there is no such mapping.</p>
      * <p><em>Note</em>: This methods behaviour is precisely
-     * defined by {@link NamespaceContext#getNamespaceURI(java.lang.String)}.
+     * defined by {@link NamespaceContext#getNamespaceURI(java.lang.String)}</p>.
      * @param pPrefix The prefix in question
      */
     public String getNamespaceURI(String pPrefix) {
@@ -157,7 +160,8 @@ public String getPrefix(String pURI) {
      * URL or null, if there is no such mapping. This method may be
      * used to find a possible prefix for an attributes namespace
      * URI. For elements you should use {@link #getPrefix(String)}.
-     * @param pURI Thhe namespace URI in question
+     * @param pURI The namespace URI in question
+     * @return the attribute prefix or null
      * @throws IllegalArgumentException The namespace URI is null.
      */
     public String getAttributePrefix(String pURI) {
@@ -220,6 +224,9 @@ public Iterator getPrefixes(String pURI) {
     }
 
 	/** Returns whether a given prefix is currently declared.
+     *
+     * @param pPrefix the namespace prefix.
+     * @return true if the prefix is declared, false otherwise.
      */
     public boolean isPrefixDeclared(String pPrefix) {
         if (cachedURI != null) {
@@ -245,6 +252,8 @@ public boolean isPrefixDeclared(String pPrefix) {
 	 * invoking 
 	 * {@link org.xml.sax.ContentHandler#endElement(String, String, String)},
 	 * the state is restored by calling {@link #checkContext(int)}.
+     *
+     * @return the current number of assigned prefixes.
 	 */
     public int getContext() {
         return (prefixList == null ? 0 : prefixList.size()) +
@@ -272,6 +281,9 @@ public int getContext() {
 	 *     h.endPrefixMapping(prefix);
 	 *   }
 	 * </pre>
+     *
+     * @param i the input state.
+     * @return the prefix.
 	 */
 	public String checkContext(int i) {
         if (getContext() == i) {
@@ -292,6 +304,8 @@ public String checkContext(int i) {
 	 * in the order of declaration. Duplicates are possible, if a
 	 * prefix has been assigned to more than one URI, or repeatedly to
 	 * the same URI.
+     *
+     * @return a list of all prefixes.
 	 */
 	public List getPrefixes() {
 		if (cachedPrefix == null) {