changeset 40405:127fac211e5c

8161965: Create initial javadoc description for modules Reviewed-by: mchung, alanb, abuckley
author lancea
date Thu, 18 Aug 2016 12:39:23 -0400
parents 167b711cf138
children 20700b077a27
files jdk/src/java.base/share/classes/module-info.java jdk/src/java.compact1/share/classes/module-info.java jdk/src/java.compact2/share/classes/module-info.java jdk/src/java.compact3/share/classes/module-info.java jdk/src/java.datatransfer/share/classes/module-info.java jdk/src/java.desktop/share/classes/module-info.java jdk/src/java.httpclient/share/classes/module-info.java jdk/src/java.instrument/share/classes/module-info.java jdk/src/java.logging/share/classes/module-info.java jdk/src/java.management/share/classes/module-info.java jdk/src/java.naming/share/classes/module-info.java jdk/src/java.prefs/share/classes/module-info.java jdk/src/java.rmi/share/classes/module-info.java jdk/src/java.scripting/share/classes/module-info.java jdk/src/java.se.ee/share/classes/module-info.java jdk/src/java.se/share/classes/module-info.java jdk/src/java.security.jgss/share/classes/module-info.java jdk/src/java.security.sasl/share/classes/module-info.java jdk/src/java.smartcardio/share/classes/module-info.java jdk/src/java.sql.rowset/share/classes/module-info.java jdk/src/java.sql/share/classes/module-info.java jdk/src/java.transaction/share/classes/module-info.java jdk/src/java.xml.crypto/share/classes/module-info.java
diffstat 23 files changed, 86 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/jdk/src/java.base/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.base/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -24,9 +24,8 @@
  */
 
 /**
- * java.base defines and exports the core APIs of the Java SE platform.
+ * Defines the foundational APIs of the Java SE Platform.
  */
-
 module java.base {
 
     exports java.io;
--- a/jdk/src/java.compact1/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.compact1/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Aggregates {@code java.base}, {@code java.logging}, and {@code java.scripting}.
+ */
 module java.compact1 {
     requires public java.logging;
     requires public java.scripting;
--- a/jdk/src/java.compact2/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.compact2/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Supplements {@code java.compact1} with JDBC, JAXP, and RMI.
+ */
 module java.compact2 {
     requires public java.compact1;
     requires public java.rmi;
--- a/jdk/src/java.compact3/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.compact3/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,10 @@
  * questions.
  */
 
+/**
+ * Supplements {@code java.compact2} with JDBC RowSet, JMX, JNDI, Compiler,
+ * Instrumentation, Preferences, Security, and XML cryptography APIs.
+ */
 module java.compact3 {
     requires public java.compact2;
     requires public java.compiler;
--- a/jdk/src/java.datatransfer/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.datatransfer/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -24,10 +24,8 @@
  */
 
 /**
- * Provides interfaces and classes for transferring data between and
- * within applications.
+ * Defines an API for transferring data between and within applications.
  */
-
 module java.datatransfer {
     exports java.awt.datatransfer;
     exports sun.datatransfer to java.desktop;
--- a/jdk/src/java.desktop/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.desktop/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -24,9 +24,9 @@
  */
 
 /**
-  * java.desktop defines and exports the user interface, graphics
-  * and imaging APIs of the Java SE platform.
-  */
+ * Defines the AWT and Swing user interface toolkits, plus APIs for
+ * accessibility, audio, imaging, printing, and JavaBeans.
+ */
 module java.desktop {
     requires public java.datatransfer;
     requires public java.xml;
--- a/jdk/src/java.httpclient/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.httpclient/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the high-level HTTP and WebSocket API.
+ */
 module java.httpclient {
     requires java.base;
     exports java.net.http;
--- a/jdk/src/java.instrument/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.instrument/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,10 @@
  * questions.
  */
 
+/**
+ * Defines services that allow agents to
+ * instrument programs running on the JVM.
+ */
 module java.instrument {
     exports java.lang.instrument;
 }
--- a/jdk/src/java.logging/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.logging/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the Java Logging API.
+ */
 module java.logging {
     exports java.util.logging;
     provides jdk.internal.logger.DefaultLoggerFinder with
--- a/jdk/src/java.management/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.management/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,12 @@
  * questions.
  */
 
+/**
+ * Defines the Java Management Extensions (JMX) API.
+ * <P>
+ * The JMX API consists of interfaces for monitoring and management of the
+ * JVM and other components in the Java runtime.
+ */
 module java.management {
     requires public java.rmi;
     requires java.logging;
--- a/jdk/src/java.naming/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.naming/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the Java Naming and Directory Interface (JNDI) API.
+ */
 module java.naming {
     requires java.security.sasl;
 
--- a/jdk/src/java.prefs/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.prefs/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the Preferences API.
+ */
 module java.prefs {
     requires java.xml;
 
--- a/jdk/src/java.rmi/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.rmi/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the Remote Method Invocation (RMI) API.
+ */
 module java.rmi {
     requires java.logging;
 
--- a/jdk/src/java.scripting/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.scripting/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the Scripting API.
+ */
 module java.scripting {
     exports javax.script;
     uses javax.script.ScriptEngineFactory;
--- a/jdk/src/java.se.ee/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.se.ee/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,12 @@
  * questions.
  */
 
+/**
+ * Defines the full API of the Java SE Platform.
+ * <P>
+ * This module requires {@code java.se} and supplements it with modules
+ * that define CORBA and Java EE APIs. These modules are upgradeable.
+ */
 module java.se.ee {
 
     requires public java.se;
--- a/jdk/src/java.se/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.se/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,13 @@
  * questions.
  */
 
+/**
+ * Defines the core Java SE API.
+ * <P>
+ * The modules defining
+ * CORBA and Java EE APIs are not required by this module, but they are
+ * required by {@code java.se.ee}.
+ */
 module java.se {
     requires public java.compact3;
     requires public java.datatransfer;
--- a/jdk/src/java.security.jgss/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.security.jgss/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,11 @@
  * questions.
  */
 
+/**
+ * Defines the Java binding of the IETF Generic Security Services API (GSS-API).
+ * <P>
+ * This module also contains GSS-API mechanisms including Kerberos v5 and SPNEGO.
+ */
 module java.security.jgss {
     requires java.naming;
     exports javax.security.auth.kerberos;
--- a/jdk/src/java.security.sasl/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.security.sasl/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,13 @@
  * questions.
  */
 
+/**
+ * Defines Java support for the IETF Simple Authentication and Security Layer
+ * (SASL).
+ * <P>
+ * This module also contains SASL mechanisms including DIGEST-MD5,
+ * CRAM-MD5, and NTLM.
+ */
 module java.security.sasl {
     requires java.logging;
 
--- a/jdk/src/java.smartcardio/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.smartcardio/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the Java Smart Card I/O API.
+ */
 module java.smartcardio {
     exports javax.smartcardio;
     provides java.security.Provider with sun.security.smartcardio.SunPCSC;
--- a/jdk/src/java.sql.rowset/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.sql.rowset/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the JDBC RowSet API.
+ */
 module java.sql.rowset {
     requires public java.logging;
     requires public java.naming;
--- a/jdk/src/java.sql/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.sql/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines the JDBC API.
+ */
 module java.sql {
     requires public java.logging;
     requires public java.xml;
--- a/jdk/src/java.transaction/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.transaction/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,12 @@
  * questions.
  */
 
+/**
+ * Defines a subset of the Java Transaction API (JTA) to support CORBA interop.
+ * <P>
+ * The subset consists of RMI exception types which are mapped to CORBA system
+ * exceptions by the 'Java Language to IDL Mapping Specification'.
+ */
 module java.transaction {
     requires public java.rmi;
     exports javax.transaction;
--- a/jdk/src/java.xml.crypto/share/classes/module-info.java	Wed Aug 17 16:03:52 2016 -0700
+++ b/jdk/src/java.xml.crypto/share/classes/module-info.java	Thu Aug 18 12:39:23 2016 -0400
@@ -23,6 +23,9 @@
  * questions.
  */
 
+/**
+ * Defines an API for XML cryptography.
+ */
 module java.xml.crypto {
     requires public java.xml;
     requires java.logging;