Re: [PR] [XERCESJ-1781] Javadoc fixes [xerces-j]

elharo commented on code in PR #44:
URL: https://github.com/apache/xerces-j/pull/44#discussion_r2506927616


##########
src/org/apache/xerces/jaxp/datatype/DatatypeFactoryImpl.java:
##########
@@ -233,12 +234,11 @@ public XMLGregorianCalendar newXMLGregorianCalendar(final String lexicalRepresen
     /**
      * <p>Create an <code>XMLGregorianCalendar</code> from a {@link GregorianCalendar}.</p> 
      *
-     * <table border="2" rules="all" cellpadding="2">
+     * <table border="1">

Review Comment:
   what happened to rules="all"
   
   Please don't remove markup without replcement



##########
src/org/apache/xerces/stax/events/NotationDeclarationImpl.java:
##########
@@ -39,9 +41,13 @@ public final class NotationDeclarationImpl extends XMLEventImpl implements
     private final String fName;
 
     /**
-     * @param eventType
-     * @param location
-     * @param schemaType
+     * Constructor for an implementation of {@link NotationDeclaration}.
+     *
+     * @param name the name
+     * @param publicId the public id

Review Comment:
   ID
   



##########
src/org/apache/xerces/dom/DOMNormalizer.java:
##########
@@ -1048,11 +1048,10 @@ protected final void namespaceFixUp (ElementImpl element, AttributeMap attribute
      * attribute with the given prefix and value for URI.
      * In case prefix is empty will add/update default namespace declaration.
      * 
-     * @param prefix
-     * @param uri
-     * @exception IOException
+     * @param prefix the text to use as a namespace
+     * @param uri the uri that is being namespaced

Review Comment:
   the URI



##########
src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java:
##########
@@ -216,8 +216,8 @@ public class XMLDocumentFragmentScannerImpl
 
     // other info
 
-    /** Document system identifier. 
-     * REVISIT:  So what's this used for?  - NG
+    /* Document system identifier.
+     * TODO: REVISIT:  So what's this used for?  - NG

Review Comment:
   just remove this line



##########
src/org/apache/xerces/stax/events/NotationDeclarationImpl.java:
##########
@@ -39,9 +41,13 @@ public final class NotationDeclarationImpl extends XMLEventImpl implements
     private final String fName;
 
     /**
-     * @param eventType
-     * @param location
-     * @param schemaType
+     * Constructor for an implementation of {@link NotationDeclaration}.
+     *
+     * @param name the name
+     * @param publicId the public id
+     * @param systemId the system id
+     * @param location the location

Review Comment:
   this just repeats the argument name



##########
src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java:
##########
@@ -73,7 +72,7 @@
  *       <th>Related<br/>XMLGregorianCalendar<br/>Accessor(s)</th>
  *       <th>Value Range</th>
  *     </tr>
- *     <a name="datetimefield-year"/>
+ *     <a name="datetimefield-year"></a>

Review Comment:
   this should probably become an id field on the following tr element



##########
src/org/apache/xerces/stax/events/NotationDeclarationImpl.java:
##########
@@ -39,9 +41,13 @@ public final class NotationDeclarationImpl extends XMLEventImpl implements
     private final String fName;
 
     /**
-     * @param eventType
-     * @param location
-     * @param schemaType
+     * Constructor for an implementation of {@link NotationDeclaration}.
+     *
+     * @param name the name
+     * @param publicId the public id
+     * @param systemId the system id

Review Comment:
   identifier



##########
src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java:
##########
@@ -48,19 +48,18 @@
  * defined in the XML Namespace
  * <code>"http://www.w3.org/2001/XMLSchema"</code>.
  * These datatypes are normatively defined in 
- * <a href="http://www.w3.org/TR/xmlschema-2/#dateTime">W3C XML Schema 1.0 Part 2, Section 3.2.7-14</a>.</p>
+ * <a href="http://www.w3.org/TR/xmlschema-2/#dateTime">W3C XML Schema 1.0 Part 2, Section 3.2.7-14</a>.
  *
- * <p>The table below defines the mapping between XML Schema 1.0
- * date/time datatype fields and this class' fields. It also summarizes
- * the value constraints for the date and time fields defined in
- * <a href="http://www.w3.org/TR/xmlschema-2/#isoformats">W3C XML Schema 1.0 Part 2, Appendix D,
- * <i>ISO 8601 Date and Time Formats</i></a>.</p>
+ * <p>The table below defines the mapping between XML Schema 1.0 date/time datatype fields and this class' fields.
+ * It also summarizes the value constraints for the date and time fields defined in
+ * <a href="http://www.w3.org/TR/xmlschema-2/#isoformats">W3C XML Schema 1.0 Part 2, Appendix D, <i>ISO 8601 Date and Time Formats</i></a>.
+ * </p>
  * 
- * <a name="datetimefieldsmapping"/>
- * <table border="2" rules="all" cellpadding="2">
+ * <a name="datetimefieldsmapping"></a>
+ * <table border="1">
  *   <thead>
  *     <tr>
- *       <th align="center" colspan="3">
+ *       <th colspan="3">

Review Comment:
   align



##########
src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java:
##########
@@ -92,13 +91,13 @@
  *            validation does not allow for the year field to have a value of zero.
  *            </td>
  *     </tr>
- *     <a name="datetimefield-month"/>
+ *     <a name="datetimefield-month"></a>

Review Comment:
   use id on tr here and below



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]