RFR 8180349: Review JAXP Java SE 9 API javadocs

huizhe wang huizhe.wang at oracle.com
Tue May 23 17:01:09 UTC 2017


Hi,

Please review an update to the JAXP Java SE 9 API javadocs.

JBS: https://bugs.openjdk.java.net/browse/JDK-8180349
webrevs: http://cr.openjdk.java.net/~joehw/jdk9/8180349/webrev/

There's a lot of format changes while converting to package-info.java, 
but only minor (wording) changes to the original documentation. All in 
all, including the new package descriptions, there's no material change 
to the APIs or description of them. Below are some details.

javax.xml
     New package description.

javax.xml.catalog
     Added a summary of the package.

javax.xml.datatype
     Added "Defines" at the beginning. Added @since.

javax.xml.namespace
     Added @since.

javax.xml.parsers
     Rephrased, added a short description of the plugability layer.

javax.xml.stream and javax.xml.stream.*
     New package description.

javax.xml.transform
     Added javax.xml.transform.stax to the description.

javax.xml.transform.dom
     Format only.

javax.xml.transform.sax
     Removed from the 1st paragraph the summary that's redundant to the 
next few paragraphs, which made it consistent with the .dom package.   
The last paragraph described an example that never existed. Rephrased 
the paragraph without mentioning an example.

javax.xml.transform.stax
     New

javax.xml.transform.stream
     The 1st statement is made consistent to that of .dom/sax/stax above

javax.xml.validation
     Format and minor wording changes. Under Support for additional 
schema langauges, I removed the words "as of JDK 1.5...".

javax.xml.xpath
     Format and minor wording changes.

org.w3c.dom
     Format only

org.w3c.dom.bootstrap .events .ls .traversal .views
     New package descriptions.

org.w3c.dom.range
     Removed the paragraphs copied from the DOM specification that 
states DOM is language-neutral and etc. since they have nothing to do 
with the Java package.

org.xml.sax
     minor wording changes. The starting sentence changed to start with 
"provides" to be consistent with the other packages. The last sentence 
"XMLReader implementations need not support them" is changed to 
"XMLReader implementations are not required to support them".

org.xml.sax.ext, .helpers
     Only the start, e.g. "Provides..."

Thanks,
Joe



More information about the core-libs-dev mailing list