search

elharo / xom

XOM™ is a new XML object model. It is an open source (LGPL), tree-based API for processing XML with Java that strives for correctness, simplicity, and performance, in that order.
https://xom.nu
Other
62 stars 32 forks source link

JavaDoc warnings with Standard Doclet version 1.8.0_322 #177

Open egonw opened 2 years ago

egonw commented 2 years ago

Giving 15 errors and 1 warning (patch pending):

  [javadoc] Standard Doclet version 1.8.0_322
  [javadoc] Building tree for all the packages and classes...
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/tests/XOMTestCase.java:54: warning: no @param for name
  [javadoc]     public XOMTestCase(String name) {
  [javadoc]            ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/Comment.java:27: error: bad use of '>'
  [javadoc]  *   <code>&lt;-- This is a comment--></code>. 
  [javadoc]                                      ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/DocType.java:468: error: bad use of '>'
  [javadoc]      *  <code>&lt;!DOCTYPE book SYSTEM "docbookx.dtd"></code>. 
  [javadoc]                                                      ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/DocType.java:28: error: bad use of '>'
  [javadoc]  * <code>&lt;!DOCTYPE book SYSTEM "docbookx.dtd"></code>.
  [javadoc]                                                 ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/Element.java:662: error: reference not found
  [javadoc]      * @throws IndexOutofBoundsException if the index is negative 
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/Element.java:844: error: reference not found
  [javadoc]      * @throws NamespaceException if this element has a prefix 
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/Element.java:1237: error: bad use of '>'
  [javadoc]      * <code>xml</code>; e.g. <code>&lt;xml:space /></code>.
  [javadoc]                                                    ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/NodeFactory.java:184: error: bad use of '>'
  [javadoc]      * <code>&lt;root xmlns="https://xom.nu/fakeRoot"/></code>.
  [javadoc]                                                       ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/Nodes.java:131: error: unexpected text
  [javadoc]      * @throws <code>IndexOutOfBoundsException</code> if index is  
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/ProcessingInstruction.java:61: error: bad use of '>'
  [javadoc]      * @throws IllegalDataException if data contains "?>" or any 
  [javadoc]                                                        ^
  [javadoc] Generating /home/egonw/var/Projects/hub/xom/build/apidocs/nu/xom/package-summary.html...
  [javadoc] Copying file /home/egonw/var/Projects/hub/xom/build/src/nu/xom/doc-files/xom.png to directory /home/egonw/var/Projects/hub/xom/build/apidocs/nu/xom/doc-files...
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/xinclude/XIncluder.java:124: error: reference not found
  [javadoc]      * @throws XMLException if resolving an include element would 
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/xinclude/XIncluder.java:175: error: reference not found
  [javadoc]      * @throws XMLException if resolving an include element would 
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/xinclude/XIncluder.java:228: error: reference not found
  [javadoc]      * @throws XMLException if resolving an include element would 
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/xinclude/XIncluder.java:278: error: reference not found
  [javadoc]      * @throws XMLException if resolving an include element would 
  [javadoc]        ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/xslt/XSLTransform.java:99: error: unknown tag: samp
  [javadoc]  * <samp>-Djavax.xml.transform.TransformerFactory=<i>classname</i></samp>
  [javadoc]    ^
  [javadoc] /home/egonw/var/Projects/hub/xom/build/src/nu/xom/xslt/XSLTransform.java:99: error: unknown tag: samp
  [javadoc]  * <samp>-Djavax.xml.transform.TransformerFactory=<i>classname</i></samp>
  [javadoc]                                                                   ^
  [javadoc] Building index for all the packages and classes...
  [javadoc] Building index for all classes...
  [javadoc] Generating /home/egonw/var/Projects/hub/xom/build/apidocs/help-doc.html...
  [javadoc] 15 errors
  [javadoc] 1 warning
egonw commented 2 years ago

I looked into the "errors" for runtime exceptions. All I can find is that you do not need to report them, which is different from not allowed to document them :( This seems to me a Doclet bug.