Re: [PR] [XERCESJ-1781] Javadoc changes from PR #65 [xerces-j]

elharo (via GitHub) <[email protected]> Tue, 25 Nov 2025 22:15:57 -0000
Newsgroups gmane.text.xml.xerces-j.devel
Message-ID <PR_kwDOLzdO6M61bpbE-d7c1d515-eecb-4804-a44d-44ce1e9774de@gitbox.apache.org>
elharo commented on code in PR #68:
URL: https://github.com/apache/xerces-j/pull/68#discussion_r2561656358


##########
src/org/apache/xerces/impl/xpath/regex/REUtil.java:
##########
@@ -218,7 +218,7 @@ else if (next == '^' && offset + 1 < len) {
 
     /**
      * Sample entry.
-     * <div>Usage: <KBD>org.apache.xerces.utils.regex.REUtil &lt;regex&gt; &lt;string&gt;</KBD></div>
+     * <p>Usage: <code>org.apache.xerces.utils.regex.REUtil &lt;regex&gt; &lt;string&gt;</code></p>

Review Comment:
   That's a bug in javadoc then. File a bug there.
   
   https://html.spec.whatwg.org/#the-samp-element



##########
src/org/apache/xerces/xs/datatypes/package.html:
##########
@@ -27,6 +27,7 @@
 <BR>
 <BR>
 <TABLE border="1">
+    <caption>Mappings between XML Schema Data Type and applicable interfaces</caption>

Review Comment:
   If it's an error, that's another bug in javadoc. 
   
   WAI does not require captions on tables. I quote, "Captions and summaries provide information that can help users find, navigate, and understand tables. While they are not required in every case to meet WCAG, captions and summaries are fairly straightforward ways to provide such information that is often needed."
   
   If it's needed, add one, but this one does not appear to be needed given the existing text. 
   
   



##########
build.xml:
##########
@@ -28,7 +28,7 @@ Authors:
 
 ==================================================================== -->
 <project default="usage" basedir=".">
-    
+

Review Comment:
   possibly, but if so put them in a different PR. Let's keep independent changes clear.



-- 
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]