elharo commented on code in PR #28:
URL: https://github.com/apache/xerces-j/pull/28#discussion_r2218838998
##########
src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java:
##########
@@ -1561,8 +1561,7 @@ protected interface Dispatcher {
* @throws IOException Thrown on i/o error.
* @throws XNIException Thrown on parse error.
*/
- public boolean dispatch(boolean complete)
- throws IOException, XNIException;
+ boolean dispatch(boolean complete) throws IOException, XNIException;
Review Comment:
this is not a javadoc error, please remove from the PR and keep it focused
only on what the description and title says
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix The qname prefix. (e.g. "a")
+ * @param localpart The qname localpart. (e.g. "foo")
Review Comment:
descriptions should be less repetitive of the argument name
##########
src/org/apache/xerces/xni/Augmentations.java:
##########
@@ -48,7 +48,7 @@ public interface Augmentations {
* @return the previous value of the specified key in the Augmentations
structure,
* or <code>null</code> if it did not have one.
*/
- public Object putItem (String key, Object item);
+ Object putItem (String key, Object item);
Review Comment:
this is not a javadoc error, please remove from the PR and keep it focused
only on what the description and title says
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -71,12 +72,21 @@ public QName() {
clear();
} // <init>()
- /** Constructs a QName with the specified values. */
+ /**
+ * Constructs a QName with the specified values.
+ * @param prefix The qname prefix. (e.g. "a")
Review Comment:
initial character should be lower case; i.e. The --> the
##########
src/org/apache/xerces/xni/XMLAttributes.java:
##########
@@ -83,21 +83,22 @@ public interface XMLAttributes {
*
* @param attrIndex The attribute index.
*/
- public void removeAttributeAt(int attrIndex);
+ void removeAttributeAt(int attrIndex);
/**
- * Returns the number of attributes in the list.
+ * @return the number of attributes in the list.
Review Comment:
definitely wrong
##########
src/org/apache/xerces/xni/QName.java:
##########
@@ -125,7 +135,7 @@ public void clear() {
// Cloneable methods
//
- /** Returns a clone of this object. */
+ /** @return a clone of this object. */
Review Comment:
not sure about this, might require a newer version of JDK than we require
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
