8216313: Add ToolProvider information to jdk.jpackage API docs JDK-8200758-branch
authorherrick
Tue, 08 Jan 2019 17:12:24 -0500
branchJDK-8200758-branch
changeset 57102 343071ed57f7
parent 57101 2c738ab1d1cf
child 57103 fe6bf39ac415
8216313: Add ToolProvider information to jdk.jpackage API docs Reviewed-by: kcr
src/jdk.jpackage/share/classes/module-info.java
--- a/src/jdk.jpackage/share/classes/module-info.java	Tue Jan 08 10:41:50 2019 -0500
+++ b/src/jdk.jpackage/share/classes/module-info.java	Tue Jan 08 17:12:24 2019 -0500
@@ -28,6 +28,13 @@
  *
  * <p>jpackage is a tool for generating self-contained application bundles.
  *
+ * <p> This module provides the equivalent of command-line access to <em>jpackage</em>
+ * via the {@link java.util.spi.ToolProvider ToolProvider} SPI.
+ * Instances of the tool can be obtained by calling
+ * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
+ * or the {@link java.util.ServiceLoader service loader} with the name
+ * {@code "jpackage"}.
+ *
  * @moduleGraph
  * @since 13
  */