Copilot commented on code in PR #40:
URL: https://github.com/apache/xerces-j/pull/40#discussion_r2462945968
##########
src/org/apache/xerces/util/XMLChar.java:
##########
@@ -37,10 +37,9 @@
* @author Glenn Marcy, IBM
* @author Andy Clark, IBM
* @author Eric Ye, IBM
- * @author Arnaud Le Hors, IBM
+ * @author Arnaud Le Hors, IBM
* @author Michael Glavassevich, IBM
- * @author Rahul Srivastava, Sun Microsystems Inc.
- *
+ * @author Rahul Srivastava, Sun Microsystems Inc
Review Comment:
The author tag is missing a period at the end. According to Oracle Javadoc
conventions, author tags should end with appropriate punctuation (typically a
period). This should be 'Sun Microsystems Inc.' to match the format used in
other files.
```suggestion
* @author Rahul Srivastava, Sun Microsystems Inc.
```
##########
src/org/apache/xerces/util/URI.java:
##########
@@ -21,68 +21,73 @@
import java.io.Serializable;
import java.util.Locale;
-/**********************************************************************
-* A class to represent a Uniform Resource Identifier (URI). This class
-* is designed to handle the parsing of URIs and provide access to
-* the various components (scheme, host, port, userinfo, path, query
-* string and fragment) that may constitute a URI.
-* <p>
-* Parsing of a URI specification is done according to the URI
-* syntax described in
-* <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
-* and amended by
-* <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
-* <p>
-* Every absolute URI consists of a scheme, followed by a colon (':'),
-* followed by a scheme-specific part. For URIs that follow the
-* "generic URI" syntax, the scheme-specific part begins with two
-* slashes ("//") and may be followed by an authority segment (comprised
-* of user information, host, and port), path segment, query segment
-* and fragment. Note that RFC 2396 no longer specifies the use of the
-* parameters segment and excludes the "user:password" syntax as part of
-* the authority segment. If "user:password" appears in a URI, the entire
-* user/password string is stored as userinfo.
-* <p>
-* For URIs that do not follow the "generic URI" syntax (e.g. mailto),
-* the entire scheme-specific part is treated as the "path" portion
-* of the URI.
-* <p>
-* Note that, unlike the java.net.URL class, this class does not provide
-* any built-in network access functionality nor does it provide any
-* scheme-specific functionality (for example, it does not know a
-* 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$
-*
-**********************************************************************/
+/**
+ * *******************************************************************
+ * A class to represent a Uniform Resource Identifier (URI). This class
+ * is designed to handle the parsing of URIs and provide access to
+ * the various components (scheme, host, port, userinfo, path, query
+ * string and fragment) that may constitute a URI.
+ * <p>
+ * Parsing of a URI specification is done according to the URI
+ * syntax described in
+ * <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
+ * and amended by
+ * <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
+ * <p>
+ * Every absolute URI consists of a scheme, followed by a colon (':'),
+ * followed by a scheme-specific part. For URIs that follow the
+ * "generic URI" syntax, the scheme-specific part begins with two
+ * slashes ("//") and may be followed by an authority segment (comprised
+ * of user information, host, and port), path segment, query segment
+ * and fragment. Note that RFC 2396 no longer specifies the use of the
+ * parameters segment and excludes the "user:password" syntax as part of
+ * the authority segment. If "user:password" appears in a URI, the entire
+ * user/password string is stored as userinfo.
+ * <p>
+ * For URIs that do not follow the "generic URI" syntax (e.g. mailto),
+ * the entire scheme-specific part is treated as the "path" portion
+ * of the URI.
+ * <p>
+ * Note that, unlike the java.net.URL class, this class does not provide
+ * any built-in network access functionality nor does it provide any
+ * scheme-specific functionality (for example, it does not know a
+ * 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$
+ */
public class URI implements Serializable {
- /*******************************************************************
- * MalformedURIExceptions are thrown in the process of building a URI
- * or setting fields on a URI when an operation would result in an
- * invalid URI specification.
- *
- ********************************************************************/
+ /**
+ * ****************************************************************
+ * MalformedURIExceptions are thrown in the process of building a URI
+ * or setting fields on a URI when an operation would result in an
+ * invalid URI specification.
+ *
+ * *****************************************************************
+ */
public static class MalformedURIException extends IOException {
/** Serialization version. */
static final long serialVersionUID = -6695054834342951930L;
- /******************************************************************
+ /**
+ * ***************************************************************
* Constructs a <code>MalformedURIException</code> with no specified
* detail message.
- ******************************************************************/
+ * ***************************************************************
+ */
public MalformedURIException() {
super();
}
- /*****************************************************************
- * Constructs a <code>MalformedURIException</code> with the
- * specified detail message.
- *
- * @param p_msg the detail message.
- ******************************************************************/
+ /**
+ * **************************************************************
Review Comment:
Another instance of non-standard asterisk separator formatting. Remove the
asterisk line on line 85 to comply with Oracle Javadoc conventions.
```suggestion
```
##########
src/org/apache/xerces/util/DOMErrorHandlerWrapper.java:
##########
@@ -34,10 +34,9 @@
/**
* This class handles DOM errors .
*
- * @see DOMErrorHandler
- *
- * @author Gopal Sharma, SUN Microsystems Inc.
+ * @author Gopal Sharma, SUN Microsystems Inc
Review Comment:
Missing period at end of author tag. Should be 'SUN MicroSystems Inc.' on
line 37 to match Oracle Javadoc conventions and maintain consistency with other
author tags that include periods.
```suggestion
* @author Gopal Sharma, SUN Microsystems Inc.
```
##########
src/org/apache/xerces/util/URI.java:
##########
@@ -21,68 +21,73 @@
import java.io.Serializable;
import java.util.Locale;
-/**********************************************************************
-* A class to represent a Uniform Resource Identifier (URI). This class
-* is designed to handle the parsing of URIs and provide access to
-* the various components (scheme, host, port, userinfo, path, query
-* string and fragment) that may constitute a URI.
-* <p>
-* Parsing of a URI specification is done according to the URI
-* syntax described in
-* <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
-* and amended by
-* <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
-* <p>
-* Every absolute URI consists of a scheme, followed by a colon (':'),
-* followed by a scheme-specific part. For URIs that follow the
-* "generic URI" syntax, the scheme-specific part begins with two
-* slashes ("//") and may be followed by an authority segment (comprised
-* of user information, host, and port), path segment, query segment
-* and fragment. Note that RFC 2396 no longer specifies the use of the
-* parameters segment and excludes the "user:password" syntax as part of
-* the authority segment. If "user:password" appears in a URI, the entire
-* user/password string is stored as userinfo.
-* <p>
-* For URIs that do not follow the "generic URI" syntax (e.g. mailto),
-* the entire scheme-specific part is treated as the "path" portion
-* of the URI.
-* <p>
-* Note that, unlike the java.net.URL class, this class does not provide
-* any built-in network access functionality nor does it provide any
-* scheme-specific functionality (for example, it does not know a
-* 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$
-*
-**********************************************************************/
+/**
+ * *******************************************************************
+ * A class to represent a Uniform Resource Identifier (URI). This class
+ * is designed to handle the parsing of URIs and provide access to
+ * the various components (scheme, host, port, userinfo, path, query
+ * string and fragment) that may constitute a URI.
+ * <p>
+ * Parsing of a URI specification is done according to the URI
+ * syntax described in
+ * <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
+ * and amended by
+ * <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
+ * <p>
+ * Every absolute URI consists of a scheme, followed by a colon (':'),
+ * followed by a scheme-specific part. For URIs that follow the
+ * "generic URI" syntax, the scheme-specific part begins with two
+ * slashes ("//") and may be followed by an authority segment (comprised
+ * of user information, host, and port), path segment, query segment
+ * and fragment. Note that RFC 2396 no longer specifies the use of the
+ * parameters segment and excludes the "user:password" syntax as part of
+ * the authority segment. If "user:password" appears in a URI, the entire
+ * user/password string is stored as userinfo.
+ * <p>
+ * For URIs that do not follow the "generic URI" syntax (e.g. mailto),
+ * the entire scheme-specific part is treated as the "path" portion
+ * of the URI.
+ * <p>
+ * Note that, unlike the java.net.URL class, this class does not provide
+ * any built-in network access functionality nor does it provide any
+ * scheme-specific functionality (for example, it does not know a
+ * 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$
+ */
public class URI implements Serializable {
- /*******************************************************************
- * MalformedURIExceptions are thrown in the process of building a URI
- * or setting fields on a URI when an operation would result in an
- * invalid URI specification.
- *
- ********************************************************************/
+ /**
+ * ****************************************************************
Review Comment:
Similar to the previous comment, this asterisk separator line creates
non-standard Javadoc formatting. The separator line with asterisks on line 62
should be removed to follow Oracle Javadoc conventions.
##########
src/org/apache/xerces/util/URI.java:
##########
@@ -21,68 +21,73 @@
import java.io.Serializable;
import java.util.Locale;
-/**********************************************************************
-* A class to represent a Uniform Resource Identifier (URI). This class
-* is designed to handle the parsing of URIs and provide access to
-* the various components (scheme, host, port, userinfo, path, query
-* string and fragment) that may constitute a URI.
-* <p>
-* Parsing of a URI specification is done according to the URI
-* syntax described in
-* <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
-* and amended by
-* <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
-* <p>
-* Every absolute URI consists of a scheme, followed by a colon (':'),
-* followed by a scheme-specific part. For URIs that follow the
-* "generic URI" syntax, the scheme-specific part begins with two
-* slashes ("//") and may be followed by an authority segment (comprised
-* of user information, host, and port), path segment, query segment
-* and fragment. Note that RFC 2396 no longer specifies the use of the
-* parameters segment and excludes the "user:password" syntax as part of
-* the authority segment. If "user:password" appears in a URI, the entire
-* user/password string is stored as userinfo.
-* <p>
-* For URIs that do not follow the "generic URI" syntax (e.g. mailto),
-* the entire scheme-specific part is treated as the "path" portion
-* of the URI.
-* <p>
-* Note that, unlike the java.net.URL class, this class does not provide
-* any built-in network access functionality nor does it provide any
-* scheme-specific functionality (for example, it does not know a
-* 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$
-*
-**********************************************************************/
+/**
+ * *******************************************************************
Review Comment:
The asterisk separator line creates unusual formatting. This should be a
standard Javadoc comment without the asterisk line separator on line 25, as
this non-standard formatting is inconsistent with Oracle Javadoc conventions.
```suggestion
```
##########
src/org/apache/xerces/util/XMLGrammarPoolImpl.java:
##########
@@ -211,8 +210,8 @@ public Grammar getGrammar(XMLGrammarDescription desc) {
* is used as the key for DTD grammars and the target namespace is used
* as the key for Schema grammars.
*
- * @param desc The Grammar Description.
- * @return The removed grammar.
+ * @param desc the Grammar Description
+ * @return The removed grammar
Review Comment:
Inconsistent capitalization in return tag. The return description starts
with 'The' (uppercase) while other updated return tags in the same file use
lowercase. This should be 'the removed grammar' to maintain consistency with
the PR's standardization goal.
```suggestion
* @return the removed grammar
```
##########
src/org/apache/xerces/util/URI.java:
##########
@@ -21,68 +21,73 @@
import java.io.Serializable;
import java.util.Locale;
-/**********************************************************************
-* A class to represent a Uniform Resource Identifier (URI). This class
-* is designed to handle the parsing of URIs and provide access to
-* the various components (scheme, host, port, userinfo, path, query
-* string and fragment) that may constitute a URI.
-* <p>
-* Parsing of a URI specification is done according to the URI
-* syntax described in
-* <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
-* and amended by
-* <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
-* <p>
-* Every absolute URI consists of a scheme, followed by a colon (':'),
-* followed by a scheme-specific part. For URIs that follow the
-* "generic URI" syntax, the scheme-specific part begins with two
-* slashes ("//") and may be followed by an authority segment (comprised
-* of user information, host, and port), path segment, query segment
-* and fragment. Note that RFC 2396 no longer specifies the use of the
-* parameters segment and excludes the "user:password" syntax as part of
-* the authority segment. If "user:password" appears in a URI, the entire
-* user/password string is stored as userinfo.
-* <p>
-* For URIs that do not follow the "generic URI" syntax (e.g. mailto),
-* the entire scheme-specific part is treated as the "path" portion
-* of the URI.
-* <p>
-* Note that, unlike the java.net.URL class, this class does not provide
-* any built-in network access functionality nor does it provide any
-* scheme-specific functionality (for example, it does not know a
-* 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$
-*
-**********************************************************************/
+/**
+ * *******************************************************************
+ * A class to represent a Uniform Resource Identifier (URI). This class
+ * is designed to handle the parsing of URIs and provide access to
+ * the various components (scheme, host, port, userinfo, path, query
+ * string and fragment) that may constitute a URI.
+ * <p>
+ * Parsing of a URI specification is done according to the URI
+ * syntax described in
+ * <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396";>RFC 2396</a>,
+ * and amended by
+ * <a href="http://www.ietf.org/rfc/rfc2732.txt?number=2732";>RFC 2732</a>.
+ * <p>
+ * Every absolute URI consists of a scheme, followed by a colon (':'),
+ * followed by a scheme-specific part. For URIs that follow the
+ * "generic URI" syntax, the scheme-specific part begins with two
+ * slashes ("//") and may be followed by an authority segment (comprised
+ * of user information, host, and port), path segment, query segment
+ * and fragment. Note that RFC 2396 no longer specifies the use of the
+ * parameters segment and excludes the "user:password" syntax as part of
+ * the authority segment. If "user:password" appears in a URI, the entire
+ * user/password string is stored as userinfo.
+ * <p>
+ * For URIs that do not follow the "generic URI" syntax (e.g. mailto),
+ * the entire scheme-specific part is treated as the "path" portion
+ * of the URI.
+ * <p>
+ * Note that, unlike the java.net.URL class, this class does not provide
+ * any built-in network access functionality nor does it provide any
+ * scheme-specific functionality (for example, it does not know a
+ * 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$
+ */
public class URI implements Serializable {
- /*******************************************************************
- * MalformedURIExceptions are thrown in the process of building a URI
- * or setting fields on a URI when an operation would result in an
- * invalid URI specification.
- *
- ********************************************************************/
+ /**
+ * ****************************************************************
+ * MalformedURIExceptions are thrown in the process of building a URI
+ * or setting fields on a URI when an operation would result in an
+ * invalid URI specification.
+ *
+ * *****************************************************************
+ */
public static class MalformedURIException extends IOException {
/** Serialization version. */
static final long serialVersionUID = -6695054834342951930L;
- /******************************************************************
+ /**
+ * ***************************************************************
Review Comment:
The asterisk separator creates non-standard formatting. Line 75 should not
contain asterisk separators as this violates Oracle Javadoc conventions.
##########
src/org/apache/xerces/util/ParserConfigurationSettings.java:
##########
@@ -183,11 +181,10 @@ public void setProperty(String propertyId, Object value)
/**
* Returns the state of a feature.
- *
- * @param featureId The feature identifier.
- * @return true if the feature is supported
- *
- * @throws XMLConfigurationException Thrown for configuration error.
+ *
+ * @param featureId the feature identifier
+ * @return true if the feature is supported
+ * @throws XMLConfigurationException thrown for configuration error.
Review Comment:
Inconsistent sentence ending. The exception description ends with a period
on line 187 ('error.'), but line 211 in the same file has the same text. One
uses a period, creating inconsistency in the documentation style.
##########
src/org/apache/xerces/util/MessageFormatter.java:
##########
@@ -40,17 +38,15 @@ public interface MessageFormatter {
/**
* Formats a message with the specified arguments using the given
* locale information.
- *
- * @param locale The locale of the message.
- * @param key The message key.
- * @param arguments The message replacement text arguments. The order
+ *
+ * @param locale the locale of the message
+ * @param key the message key
+ * @param arguments the message replacement text arguments. The order
* of the arguments must match that of the placeholders
* in the actual message.
- *
- * @return Returns the formatted message.
- *
- * @throws MissingResourceException Thrown if the message with the
- * specified key cannot be found.
+ * @return returns the formatted message
Review Comment:
Redundant wording in return tag. The description 'returns the formatted
message' on line 47 is redundant since @return already indicates that something
is being returned. Should be '@return the formatted message' to match the style
used elsewhere in the PR.
```suggestion
* @return the formatted message
```
##########
src/org/apache/xerces/util/AugmentationsImpl.java:
##########
@@ -61,29 +60,27 @@ public Object putItem (String key, Object item){
}
/**
- * Get information identified by a key from the Augmentations structure
- *
- * @param key Identifier, can't be <code>null</code>
+ * Get information identified by a key from the Augmentations structure.
*
+ * @param key identifier, can't be <code>null</code>
* @return the value to which the key is mapped in the Augmentations
structure;
- * <code>null</code> if the key is not mapped to any value.
+ * <code>null</code> if the key is not mapped to any value
*/
public Object getItem(String key){
return fAugmentationsContainer.getItem(key);
}
/**
- * Remove additional info from the Augmentations structure
- *
- * @param key Identifier, can't be <code>null</code>
+ * Remove additional info from the Augmentations structure.
+ *
+ * @param key identifier, can't be <code>null</code>
Review Comment:
Inconsistent capitalization in parameter description. On line 76,
'identifier' starts with lowercase, but on lines 47 and 65 in the same file,
the same parameter uses lowercase. However, the pattern should be consistent.
Since most have been changed to lowercase, this should remain lowercase, but
verify consistency across all three occurrences.
##########
src/org/apache/xerces/util/DOMEntityResolverWrapper.java:
##########
@@ -35,12 +35,11 @@
/**
* This class wraps DOM entity resolver to XNI entity resolver.
*
- * @see LSResourceResolver
- *
- * @author Gopal Sharma, SUN MicroSystems Inc.
- * @author Elena Litani, IBM
+ * @author Gopal Sharma, SUN MicroSystems Inc
Review Comment:
Missing period at end of author tag. Should be 'SUN MicroSystems Inc.' on
line 38 to follow Oracle Javadoc conventions and maintain consistency.
```suggestion
* @author Gopal Sharma, SUN MicroSystems Inc.
```
--
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]
