jdk/src/jdk.jlink/share/classes/module-info.java

@@ -22,11 +22,35 @@
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
 
 /**
- * Defines the Java linker tool, jlink.
+ * Defines tools for linking, inspecting modules into a run-time image, and
+ * packaging JMOD files including the <em>{@index jlink jlink}</em>,
+ * <em>{@index jimage jimage}</em> and <em>{@index jmod jmod}</em> tools.
+ *
+ * <p> This module provides the equivalent of command-line access to the
+ * <em>{@extLink jlink_tool_reference jlink}</em> and
+ * <em>{@extLink jmod_tool_reference jmod}</em> tools via the
+ * {@link java.util.spi.ToolProvider ToolProvider} SPI.
+ *
+ * <p> Instances of the tools 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 "jlink"} or {@code "jmod"} as appropriate.
+ *
+ * <p> <em>{@extLink jimage_tool_reference jimage}</em> just exists
+ * as a command-line tool, and does not provide any direct API.
+ *
+ * <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
+ * <dt class="simpleTagLabel">Tool Guides:
+ * <dd>{@extLink jlink_tool_reference jlink},
+ *     {@extLink jmod_tool_reference jmod},
+ *     {@extLink jimage_tool_reference jimage}
+ * </dl>
+ *
+ * @provides java.util.spi.ToolProvider
  *
  * @moduleGraph
  * @since 9
  */
 module jdk.jlink {