src/jdk.javadoc/share/classes/module-info.java
author mikael
Mon, 09 Apr 2018 10:19:33 -0700
changeset 49552 05883543ee2a
parent 49415 56a5f899e882
child 50205 95ba3a1dc2b2
permissions -rw-r--r--
8201263: Trailing backslash in VS120COMNTOOLS leads to ugly error message when running tests Reviewed-by: erikj
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     1
/*
49415
56a5f899e882 8199902: {@docRoot} references need to be updated to reflect new module/package structure
jjg
parents: 47216
diff changeset
     2
 * Copyright (c) 2014, 2018, Oracle and/or its affiliates. All rights reserved.
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     4
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    10
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    15
 * accompanied this code).
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    16
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    20
 *
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    23
 * questions.
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    24
 */
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    25
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    26
/**
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    27
 * Defines the implementation of the
45796
830e16e5eef5 8182776: Fix typos in module declarations
mr
parents: 45684
diff changeset
    28
 * {@linkplain javax.tools.ToolProvider#getSystemDocumentationTool system documentation tool}
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    29
 * and its command line equivalent, <em>{@index javadoc javadoc tool}</em>.
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    30
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    31
 * <h2 style="font-family:'DejaVu Sans Mono', monospace; font-style:italic">javadoc</h2>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    32
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    33
 * <p>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    34
 * This module provides the equivalent of command-line access to <em>javadoc</em>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    35
 * via the {@link java.util.spi.ToolProvider ToolProvider} and
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    36
 * {@link javax.tools.Tool} service provider interfaces (SPIs),
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    37
 * and more flexible access via the {@link javax.tools.DocumentationTool DocumentationTool}
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    38
 * SPI.</p>
43862
a9b0f76e15bf 8174695: Fix @since in module-info.java in dev/langtools repo
mli
parents: 42498
diff changeset
    39
 *
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    40
 * <p> Instances of the tools can be obtained by calling
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    41
 * {@link java.util.spi.ToolProvider#findFirst ToolProvider.findFirst}
45796
830e16e5eef5 8182776: Fix typos in module declarations
mr
parents: 45684
diff changeset
    42
 * or the {@linkplain java.util.ServiceLoader service loader} with the name
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    43
 * {@code "javadoc"}.
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    44
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    45
 * <dl style="font-family:'DejaVu Sans', Arial, Helvetica, sans serif">
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    46
 * <dt class="simpleTagLabel">Tool Guides:
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    47
 * <dd>{@extLink javadoc_tool_reference javadoc}
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    48
 * </dl>
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    49
 *
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    50
 * @provides java.util.spi.ToolProvider
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    51
 * @provides javax.tools.DocumentationTool
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    52
 * @provides javax.tools.Tool
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    53
 *
49415
56a5f899e882 8199902: {@docRoot} references need to be updated to reflect new module/package structure
jjg
parents: 47216
diff changeset
    54
 * @see <a href="{@docRootParent}/specs/doc-comment-spec.html">
45548
7db465d26194 8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents: 44452
diff changeset
    55
 *      Documentation Comment Specification for the Standard Doclet</a>
7db465d26194 8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents: 44452
diff changeset
    56
 *
45680
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    57
 * @moduleGraph
6a7b5298fcf5 8181825: Add tool and services information to module summary
jjg
parents: 45548
diff changeset
    58
 * @since 9
40507
4413083331c7 8162576: Missing doclint check missing for modules
sadayapalam
parents: 39179
diff changeset
    59
 */
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    60
module jdk.javadoc {
45684
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    61
    requires java.xml;
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    62
42407
f3702cff2933 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41448
diff changeset
    63
    requires transitive java.compiler;
f3702cff2933 8169069: Module system implementation refresh (11/2016)
alanb
parents: 41448
diff changeset
    64
    requires transitive jdk.compiler;
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    65
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    66
    exports com.sun.javadoc;
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    67
    exports com.sun.tools.javadoc;
39179
c04b68e23fa4 8154399: Need replacement for jdk.javadoc/com.sun.tools.doclets.standard.Standard
jjg
parents: 36526
diff changeset
    68
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    69
    exports jdk.javadoc.doclet;
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    70
45684
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    71
    provides java.util.spi.ToolProvider with
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    72
        jdk.javadoc.internal.tool.JavadocToolProvider;
41448
6689bce0cd65 8159855: Create an SPI for tools
jjg
parents: 40507
diff changeset
    73
45684
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    74
    provides javax.tools.DocumentationTool with
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    75
        jdk.javadoc.internal.api.JavadocTool;
42498
ceaf5bafa1b5 8170251: Add javax.tools.Tool.name()
jjg
parents: 42407
diff changeset
    76
45684
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    77
    provides javax.tools.Tool with
2c5f2779c3d1 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45680
diff changeset
    78
        jdk.javadoc.internal.api.JavadocTool;
36526
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    79
}
3b41f1c69604 8142968: Module System implementation
alanb
parents:
diff changeset
    80