RFR 8161965 -> Fwd: JDK 9 RFR of 8161402: Provide a javadoc description for java.prefs module
Alan Bateman
Alan.Bateman at oracle.com
Thu Jul 21 17:03:04 UTC 2016
On 21/07/2016 17:37, Lance Andersen wrote:
> I took a stab at the javadoc descriptions for the modules modeled after what we discussed for the java.prefs module.
>
> The webrev can be found at http://cr.openjdk.java.net/~lancea/8161965/ <http://cr.openjdk.java.net/~lancea/8161965/>
It's good to do these in bulk and get some consistently.
A general comment is that it uses acronyms for several APIs. For example
java.xml say "JAXP" then I assume it should have "XML Processing". JDBC,
JNDI, JAXB, ... there are several that I think should be clearer.
java.activation has "activation API", shouldn't this be "JavaBeans
Activation Framework".
I'm not sure what to say for java.annotations.common. I think it has to
say something about it defining a subset of the Common Annotations.
For java.transaction then the exceptions also for interop with CORBA
Transaction Services. The text might need to say that it's the Java SE
subset of the Java Transaction API.
The java.management module exports java.lang.management so that will
need text.
I think Jon Gibbons is working on text for java.compiler and
jdk.compiler so you might be able to drop java.compiler from your patch.
-Alan
More information about the core-libs-dev
mailing list