This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/xerces-j.git
The following commit(s) were added to refs/heads/main by this push:
new 46ea35fd2 [XERCESJ-1781] fix more Javadoc warnings (#62)
46ea35fd2 is described below
commit 46ea35fd2b36c23fcfc1be70fce63c5855161d80
Author: Samael <[email protected]>
AuthorDate: Thu Nov 20 22:54:59 2025 +0000
[XERCESJ-1781] fix more Javadoc warnings (#62)
* [XERCESJ-1781] fix more Javadoc warnings
* [XERCESJ-1781] fix more Javadoc warnings
---
src/org/apache/xerces/xni/NamespaceContext.java | 3 ++
src/org/apache/xerces/xni/XMLLocator.java | 61 +++++++++++++++++++------
src/org/apache/xerces/xni/XMLString.java | 7 ++-
3 files changed, 55 insertions(+), 16 deletions(-)
diff --git a/src/org/apache/xerces/xni/NamespaceContext.java
b/src/org/apache/xerces/xni/NamespaceContext.java
index 3271dac56..3575c2eb8 100644
--- a/src/org/apache/xerces/xni/NamespaceContext.java
+++ b/src/org/apache/xerces/xni/NamespaceContext.java
@@ -158,6 +158,9 @@ public interface NamespaceContext {
/**
* Returns the prefix at the specified index in the current context.
+ *
+ * @param index the location of the declared prefix in the current context
+ * @return the prefix at the specified index in the current context
*/
public String getDeclaredPrefixAt(int index);
diff --git a/src/org/apache/xerces/xni/XMLLocator.java
b/src/org/apache/xerces/xni/XMLLocator.java
index 4caf22382..a07fc1272 100644
--- a/src/org/apache/xerces/xni/XMLLocator.java
+++ b/src/org/apache/xerces/xni/XMLLocator.java
@@ -30,46 +30,77 @@ public interface XMLLocator {
// XMLLocator methods
//
- /** Returns the public identifier. */
+ /**
+ * Returns the public identifier.
+ *
+ * @return the public identifier or null
+ */
public String getPublicId();
- /** Returns the literal system identifier. */
+ /**
+ * Returns the literal system identifier.
+ *
+ * @return the literal system identifier or null
+ */
public String getLiteralSystemId();
- /** Returns the base system identifier. */
+ /**
+ * Returns the base system identifier.
+ *
+ * @return the base system identifier or null
+ */
public String getBaseSystemId();
- /** Returns the expanded system identifier. */
+ /**
+ * Returns the expanded system identifier.
+ *
+ * @return the expanded system identifier or null
+ */
public String getExpandedSystemId();
- /** Returns the line number, or <code>-1</code> if no line number is
available. */
+ /**
+ * Returns the line number, or <code>-1</code> if no line number is
available.
+ *
+ * @return the line number, or <code>-1</code>
+ */
public int getLineNumber();
- /** Returns the column number, or <code>-1</code> if no column number is
available. */
+ /**
+ * Returns the column number, or <code>-1</code> if no column number is
available.
+ *
+ * @return the column number, or <code>-1</code>
+ */
public int getColumnNumber();
- /** Returns the character offset, or <code>-1</code> if no character
offset is available. */
+ /**
+ * Returns the character offset, or <code>-1</code> if no character offset
is available.
+ *
+ * @return the character offset, or <code>-1</code>
+ */
public int getCharacterOffset();
/**
- * Returns the encoding of the current entity.
- * Note that, for a given entity, this value can only be
- * considered final once the encoding declaration has been read (or once it
- * has been determined that there is no such declaration) since, no
encoding
- * having been specified on the XMLInputSource, the parser
- * will make an initial "guess" which could be in error.
+ * Returns the encoding of the current entity.
+ * <p>Note that, for a given entity, this value can only be considered
final once
+ * the encoding declaration has been read (or once it has been determined
that there
+ * is no such declaration) since, no encoding having been specified on the
XMLInputSource,
+ * the parser will make an initial "guess" which could be in error.</p>
+ *
+ * @return the encoding of the current entity or null
*/
public String getEncoding();
/**
* Returns the XML version of the current entity. This will normally be the
- * value from the XML or text declaration or defaulted by the parser. Note
that
- * that this value may be different than the version of the processing
rules
+ * value from the XML or text declaration or defaulted by the parser. Note
+ * that this value may be different from the version of the processing
rules
* applied to the current entity. For instance, an XML 1.1 document may
refer to
* XML 1.0 entities. In such a case the rules of XML 1.1 are applied to
the entire
* document. Also note that, for a given entity, this value can only be
considered
* final once the XML or text declaration has been read or once it has been
* determined that there is no such declaration.
+ *
+ * @return the XML version of the current entity or null
*/
public String getXMLVersion();
diff --git a/src/org/apache/xerces/xni/XMLString.java
b/src/org/apache/xerces/xni/XMLString.java
index 649033f72..015c32159 100644
--- a/src/org/apache/xerces/xni/XMLString.java
+++ b/src/org/apache/xerces/xni/XMLString.java
@@ -182,7 +182,12 @@ public class XMLString {
// Object methods
//
- /** Returns a string representation of this object. */
+ /**
+ * Returns a string representation of this object.
+ * <p>A new String will be returned based on the chars available from the
current offset up to the current length.</p>
+ *
+ * @return the text contained from the current offset up to the current
length
+ */
public String toString() {
return length > 0 ? new String(ch, offset, length) : "";
} // toString():String
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
