module-info.java revision 4213:bbb3a10fce39
1/* 2 * Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26/** 27 * Defines the implementation of the 28 * {@link javax.tools.ToolProvider#getSystemDocumentationTool system documentation tool} 29 * and its command line equivalent, <em>{@index javadoc javadoc tool}</em>. 30 * 31 * <h2 style="font-family:'DejaVu Sans Mono', monospace; font-style:italic">javadoc</h2> 32 * 33 * <p> 34 * This module provides the equivalent of command-line access to <em>javadoc</em> 35 * via the {@link java.util.spi.ToolProvider ToolProvider} and 36 * {@link javax.tools.Tool} service provider interfaces (SPIs), 37 * and more flexible access via the {@link javax.tools.DocumentationTool DocumentationTool} 38 * SPI.</p> 39 * 40 * <p> Instances of the tools can be obtained by calling 41 * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst} 42 * or the {@link java.util.ServiceLoader service loader} with the name 43 * {@code "javadoc"}. 44 * 45 * <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif"> 46 * <dt class="simpleTagLabel">Tool Guides: 47 * <dd>{@extLink javadoc_tool_reference javadoc} 48 * </dl> 49 * 50 * @provides java.util.spi.ToolProvider 51 * @provides javax.tools.DocumentationTool 52 * @provides javax.tools.Tool 53 * 54 * @see <a href="{@docRoot}/../specs/doc-comment-spec.html"> 55 * Documentation Comment Specification for the Standard Doclet</a> 56 * 57 * @moduleGraph 58 * @since 9 59 */ 60module jdk.javadoc { 61 requires transitive java.compiler; 62 requires transitive jdk.compiler; 63 requires java.xml; 64 65 exports com.sun.javadoc; 66 exports com.sun.tools.doclets; 67 exports com.sun.tools.doclets.standard; 68 exports com.sun.tools.javadoc; 69 70 exports jdk.javadoc.doclet; 71 72 provides java.util.spi.ToolProvider 73 with jdk.javadoc.internal.tool.JavadocToolProvider; 74 75 provides javax.tools.DocumentationTool 76 with jdk.javadoc.internal.api.JavadocTool; 77 78 provides javax.tools.Tool 79 with jdk.javadoc.internal.api.JavadocTool; 80} 81 82