mirror of
https://github.com/openjdk/jdk.git
synced 2025-08-28 15:24:43 +02:00
73 lines
2.8 KiB
Java
73 lines
2.8 KiB
Java
/*
|
|
* Copyright (c) 2014, 2019, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
/**
|
|
* Defines the implementation of the
|
|
* {@linkplain javax.tools.ToolProvider#getSystemDocumentationTool system documentation tool}
|
|
* and its command-line equivalent, <em>{@index javadoc javadoc tool}</em>.
|
|
*
|
|
* <h2 style="font-family:'DejaVu Sans Mono', monospace; font-style:italic">javadoc</h2>
|
|
*
|
|
* <p>
|
|
* This module provides the equivalent of command-line access to <em>javadoc</em>
|
|
* via the {@link java.util.spi.ToolProvider ToolProvider} and
|
|
* {@link javax.tools.Tool} service provider interfaces (SPIs),
|
|
* and more flexible access via the {@link javax.tools.DocumentationTool DocumentationTool}
|
|
* SPI.</p>
|
|
*
|
|
* <p> Instances of the tools can be obtained by calling
|
|
* {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
|
|
* or the {@linkplain java.util.ServiceLoader service loader} with the name
|
|
* {@code "javadoc"}.
|
|
*
|
|
* @toolGuide javadoc
|
|
*
|
|
* @provides java.util.spi.ToolProvider
|
|
* @provides javax.tools.DocumentationTool
|
|
* @provides javax.tools.Tool
|
|
*
|
|
* @see <a href="{@docRoot}/../specs/javadoc/doc-comment-spec.html">
|
|
* Documentation Comment Specification for the Standard Doclet</a>
|
|
*
|
|
* @moduleGraph
|
|
* @since 9
|
|
*/
|
|
module jdk.javadoc {
|
|
requires java.xml;
|
|
|
|
requires transitive java.compiler;
|
|
requires transitive jdk.compiler;
|
|
|
|
exports jdk.javadoc.doclet;
|
|
|
|
provides java.util.spi.ToolProvider with
|
|
jdk.javadoc.internal.tool.JavadocToolProvider;
|
|
|
|
provides javax.tools.DocumentationTool with
|
|
jdk.javadoc.internal.api.JavadocTool;
|
|
|
|
provides javax.tools.Tool with
|
|
jdk.javadoc.internal.api.JavadocTool;
|
|
}
|