JDK 9 RFR of 8161402: Provide a javadoc description for java.prefs module

Lance Andersen lance.andersen at oracle.com
Tue Jul 19 12:31:04 UTC 2016


I know I have to do the same for a few modules.

Do you have a preference on the wording so it consistent to help reduce follow on changes:

The {@code java.XXX} module defines and exports the XXX API


Is that the preferred direction?

> On Jul 19, 2016, at 3:12 AM, Alan Bateman <Alan.Bateman at oracle.com> wrote:
> 
> On 19/07/2016 02:57, joe darcy wrote:
> 
>> Hi Brian,
>> 
>> As as grammatical comment, I might start with "The {@code java.prefs} module defines ...", but otherwise, the change looks fine.
> Also I think it's API rather than "APIs".
> 
> At some point then we need to do a pass over all the javadoc comments in the module-info.java files to get them consistent. In this case, I could imagine changing in the future to just say that it defines and exports the preferences API.
> 
> -Alan

 <http://oracle.com/us/design/oracle-email-sig-198324.gif>
 <http://oracle.com/us/design/oracle-email-sig-198324.gif> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
 <http://oracle.com/us/design/oracle-email-sig-198324.gif>Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com <mailto:Lance.Andersen at oracle.com>





More information about the core-libs-dev mailing list