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 4dc851c7e [XERCESJ-1781] Javadoc fixes for html in org.apache.xerces
(#47)
4dc851c7e is described below
commit 4dc851c7e0b2cebf614951911788206054ae8d26
Author: Samael <[email protected]>
AuthorDate: Fri Nov 14 10:55:09 2025 +0000
[XERCESJ-1781] Javadoc fixes for html in org.apache.xerces (#47)
* [XERCESJ-1781] Javadoc fixes for html in org.apache.xerces
---
.../xerces/dom/ProcessingInstructionImpl.java | 11 ++++-------
src/org/apache/xerces/dom/TextImpl.java | 5 ++---
src/org/apache/xerces/impl/Constants.java | 2 +-
.../xerces/impl/XML11DocumentScannerImpl.java | 9 ++++-----
src/org/apache/xerces/impl/XMLDTDScannerImpl.java | 2 +-
.../impl/XMLDocumentFragmentScannerImpl.java | 4 +++-
.../apache/xerces/impl/XMLDocumentScannerImpl.java | 7 +++----
src/org/apache/xerces/impl/XMLScanner.java | 22 +++++++++++-----------
.../apache/xerces/impl/dv/DatatypeException.java | 6 +++---
.../xerces/impl/xpath/regex/RegularExpression.java | 2 +-
.../jaxp/datatype/XMLGregorianCalendarImpl.java | 2 +-
src/org/apache/xerces/util/URI.java | 2 +-
12 files changed, 35 insertions(+), 39 deletions(-)
diff --git a/src/org/apache/xerces/dom/ProcessingInstructionImpl.java
b/src/org/apache/xerces/dom/ProcessingInstructionImpl.java
index c73d6bc0f..d30c77e81 100644
--- a/src/org/apache/xerces/dom/ProcessingInstructionImpl.java
+++ b/src/org/apache/xerces/dom/ProcessingInstructionImpl.java
@@ -90,13 +90,10 @@ public class ProcessingInstructionImpl
/**
* A PI's "target" states what processor channel the PI's data
* should be directed to. It is defined differently in HTML and XML.
- * <p>
- * In XML, a PI's "target" is the first (whitespace-delimited) token
- * following the "<?" token that begins the PI.
- * <p>
- * In HTML, target is always null.
- * <p>
- * Note that getNodeName is aliased to getTarget.
+ * <p>In XML, a PI's "target" is the first (whitespace-delimited) token
+ * following the "^lt;?" token that begins the PI.</p>
+ * <p>In HTML, target is always null.</p>
+ * <p>Note that getNodeName is aliased to getTarget.</p>
*/
public String getTarget() {
if (needsSyncData()) {
diff --git a/src/org/apache/xerces/dom/TextImpl.java
b/src/org/apache/xerces/dom/TextImpl.java
index 3372f7d22..c95e1fc50 100644
--- a/src/org/apache/xerces/dom/TextImpl.java
+++ b/src/org/apache/xerces/dom/TextImpl.java
@@ -593,8 +593,7 @@ public class TextImpl
/**
* Break a text node into two sibling nodes. (Note that if the current node
- * has no parent, they won't wind up as "siblings" -- they'll both be
- * orphans.)
+ * has no parent, they won't wind up as "siblings" -- they'll both be
orphans.)
*
* @param offset the offset at which to split. If offset is at the end of
the
* available data, the second node will be empty.
@@ -602,7 +601,7 @@ public class TextImpl
* @return a reference to the new node (containing data after the offset
* point). The original node will contain data up to that point.
*
- * @throws DOMException INDEX_SIZE_ERR if offset is <0 or >length.
+ * @throws DOMException INDEX_SIZE_ERR if offset is <0 or >length.
*
* @throws DOMException NO_MODIFICATION_ALLOWED_ERR if node is read-only.
*/
diff --git a/src/org/apache/xerces/impl/Constants.java
b/src/org/apache/xerces/impl/Constants.java
index 2b4fb3eeb..4e39e7990 100644
--- a/src/org/apache/xerces/impl/Constants.java
+++ b/src/org/apache/xerces/impl/Constants.java
@@ -459,7 +459,7 @@ public final class Constants {
/**
* Boolean indicating whether a character is a probable white space
- * character (ch <= 0x20) that was the replacement text of a character
+ * character (ch <= 0x20) that was the replacement text of a character
* reference is stored in augmentations using the string
"CHAR_REF_PROBABLE_WS".
* The absence of this augmentation indicates that the character is not
* probable white space and/or was not included from a character reference.
diff --git a/src/org/apache/xerces/impl/XML11DocumentScannerImpl.java
b/src/org/apache/xerces/impl/XML11DocumentScannerImpl.java
index c0318c5f9..8ff483b7e 100644
--- a/src/org/apache/xerces/impl/XML11DocumentScannerImpl.java
+++ b/src/org/apache/xerces/impl/XML11DocumentScannerImpl.java
@@ -136,8 +136,12 @@ public class XML11DocumentScannerImpl
* Scans an attribute value and normalizes whitespace converting all
* whitespace characters to space characters.
* <pre>
+ * {@code
* [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] |
Reference)* "'"
+ * }
* </pre>
+ * <p><strong>Note:</strong> This method uses fStringBuffer2, anything in
it at the time
+ * of calling is lost.</p>
*
* @param value the XMLString to fill in with the value
* @param nonNormalizedValue the XMLString to fill in with the
non-normalized value
@@ -147,11 +151,6 @@ public class XML11DocumentScannerImpl
* @param eleName the name of element to which this attribute belongs
*
* @return true if the non-normalized and normalized value are the same
- *
- * <p>
- * <strong>Note:</strong> This method uses fStringBuffer2, anything in it
at the time
- * of calling is lost.
- * </p>
*/
protected boolean scanAttributeValue(XMLString value,
XMLString nonNormalizedValue,
diff --git a/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
b/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
index 7ed158a6f..f0695721e 100644
--- a/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
+++ b/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
@@ -747,7 +747,7 @@ public class XMLDTDScannerImpl
/**
* Scans a comment.
* <pre>
- * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
+ * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
* </pre>
* <strong>Note:</strong> Called after scanning past '<!--'
*/
diff --git a/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
b/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
index 4e448ee96..0441fcd0a 100644
--- a/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
+++ b/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
@@ -712,7 +712,7 @@ public class XMLDocumentFragmentScannerImpl
/**
* Scans a comment.
* <pre>
- * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
+ * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
* </pre>
* <strong>Note:</strong> Called after scanning past '<!--'
*/
@@ -1192,7 +1192,9 @@ public class XMLDocumentFragmentScannerImpl
/**
* Scans a character reference.
* <pre>
+ * {@code
* [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
+ * }
* </pre>
*/
protected void scanCharReference()
diff --git a/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
b/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
index f2984db8b..374eee871 100644
--- a/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
+++ b/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
@@ -1077,11 +1077,10 @@ public class XMLDocumentScannerImpl
/**
* Scan for DOCTYPE hook. This method is a hook for subclasses
- * to add code to handle scanning for a the "DOCTYPE" string
- * after the string "<!" has been scanned.
+ * to add code to handle scanning for the "DOCTYPE" string
+ * after the string "<!" has been scanned.
*
- * @return True if the "DOCTYPE" was scanned; false if "DOCTYPE"
- * was not scanned.
+ * @return true if the "DOCTYPE" was scanned; false if "DOCTYPE" was
not scanned
*/
protected boolean scanForDoctypeHook()
throws IOException, XNIException {
diff --git a/src/org/apache/xerces/impl/XMLScanner.java
b/src/org/apache/xerces/impl/XMLScanner.java
index c9c18d07b..8b7fe8ccc 100644
--- a/src/org/apache/xerces/impl/XMLScanner.java
+++ b/src/org/apache/xerces/impl/XMLScanner.java
@@ -206,9 +206,10 @@ public abstract class XMLScanner
//
/**
+ * Resets the component. The component can query the component manager
about
+ * any features and properties that affect the operation of the component.
*
- *
- * @param componentManager The component manager.
+ * @param componentManager the component manager
*
* @throws SAXException Throws exception if required features and
* properties cannot be found.
@@ -332,6 +333,7 @@ public abstract class XMLScanner
/**
* Scans an XML or text declaration.
* <pre>
+ * {@code
* [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'
* [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ")
* [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName
"'" )
@@ -340,7 +342,10 @@ public abstract class XMLScanner
* | ('"' ('yes' | 'no') '"'))
*
* [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'
+ * }
* </pre>
+ * <p><strong>Note:</strong> This method uses fString, anything in it at
+ * the time of calling is lost.</p>
*
* @param scanningTextDecl True if a text declaration is to
* be scanned instead of an XML
@@ -348,9 +353,6 @@ public abstract class XMLScanner
* @param pseudoAttributeValues An array of size 3 to return the version,
* encoding and standalone pseudo attribute values
* (in that order).
- *
- * <strong>Note:</strong> This method uses fString, anything in it
- * at the time of calling is lost.
*/
protected void scanXMLDeclOrTextDecl(boolean scanningTextDecl,
String[] pseudoAttributeValues)
@@ -732,7 +734,7 @@ public abstract class XMLScanner
/**
* Scans a comment.
* <pre>
- * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
+ * [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
* </pre>
* <p>
* <strong>Note:</strong> Called after scanning past '<!--'
@@ -771,8 +773,7 @@ public abstract class XMLScanner
* Scans an attribute value and normalizes whitespace converting all
* whitespace characters to space characters.
* <p>
- * <code>[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] |
Reference)* "'"</code>
- * </p>
+ * <code>[10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'"
([^<&'] | Reference)* "'"</code>
*
* @param value the XMLString to fill in with the value
* @param nonNormalizedValue the XMLString to fill in with the
non-normalized value
@@ -782,9 +783,6 @@ public abstract class XMLScanner
* @param eleName the name of element to which this attribute belongs
*
* @return true if the non-normalized and normalized value are the same
- * <p>
- * <strong>Note:</strong> This method uses fStringBuffer2, anything in it
- * at the time of calling is lost.</p>
*/
protected boolean scanAttributeValue(XMLString value,
XMLString nonNormalizedValue,
@@ -1268,7 +1266,9 @@ public abstract class XMLScanner
* Scans a character reference and append the corresponding chars to the
* specified buffer.
* <pre>
+ * {@code
* [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
+ * }
* </pre>
*
* <p>
diff --git a/src/org/apache/xerces/impl/dv/DatatypeException.java
b/src/org/apache/xerces/impl/dv/DatatypeException.java
index ca06e6323..96cf54d16 100644
--- a/src/org/apache/xerces/impl/dv/DatatypeException.java
+++ b/src/org/apache/xerces/impl/dv/DatatypeException.java
@@ -73,10 +73,10 @@ public class DatatypeException extends Exception {
}
/**
- * Overrides this method to get the formatted&localized error message.
- *
+ * Overrides this method to get the formatted&localized error message.
+ *
* REVISIT: the system locale is used to load the property file.
- * do we want to allow the appilcation to specify a
+ * do we want to allow the application to specify a
* different locale?
*/
public String getMessage() {
diff --git a/src/org/apache/xerces/impl/xpath/regex/RegularExpression.java
b/src/org/apache/xerces/impl/xpath/regex/RegularExpression.java
index 78ceb0032..825b814fb 100644
--- a/src/org/apache/xerces/impl/xpath/regex/RegularExpression.java
+++ b/src/org/apache/xerces/impl/xpath/regex/RegularExpression.java
@@ -402,7 +402,7 @@ import org.apache.xerces.util.IntStack;
* other-properties ::= 'ALL' | 'ASSIGNED' | 'UNASSIGNED'
* character-1 ::= (any character except meta-characters)
*
- * char-class ::= '[' ranges ']' | '(?[' ranges ']' ([-+&] '[' ranges ']')? ')'
+ * char-class ::= '[' ranges ']' | '(?[' ranges ']' ([-+&] '[' ranges
']')? ')'
* ranges ::= '^'? (range <a href="#COMMA_OPTION">','?</a>)+
* range ::= '\d' | '\w' | '\s' | '\D' | '\W' | '\S' | category-block
* | range-char | range-char '-' range-char
diff --git a/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
b/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
index 9c3b1a8f4..6d0b3f3a1 100644
--- a/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
+++ b/src/org/apache/xerces/jaxp/datatype/XMLGregorianCalendarImpl.java
@@ -67,7 +67,7 @@ import org.apache.xerces.util.DatatypeMessageFormatter;
* <tbody>
* <tr>
* <th>XML Schema 1.0<br/>
- * datatype<br/>
+ * datatype<br/>
* field</th>
* <th>Related<br/>XMLGregorianCalendar<br/>Accessor(s)</th>
* <th>Value Range</th>
diff --git a/src/org/apache/xerces/util/URI.java
b/src/org/apache/xerces/util/URI.java
index 72684ec9d..cd06d0b55 100644
--- a/src/org/apache/xerces/util/URI.java
+++ b/src/org/apache/xerces/util/URI.java
@@ -1783,7 +1783,7 @@ import java.util.Locale;
* '.'. Each group must consist of one to three digits. See RFC 2732 Section
3,
* and RFC 2373 Section 2.2, for the definition of IPv6 references. A
hostname
* consists of domain labels (each of which must begin and end with an
alphanumeric
- * but may contain '-') separated & by a '.'. See RFC 2396 Section 3.2.2.
+ * but may contain '-') separated by a '.'. See RFC 2396 Section 3.2.2.
*
* @return true if the string is a syntactically valid IPv4 address,
* IPv6 reference or hostname
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
