author | pliden |
Tue, 06 Aug 2019 15:50:30 +0200 | |
changeset 57660 | c0a7c7161d3a |
parent 55202 | 7c49133fc1bc |
permissions | -rw-r--r-- |
36526 | 1 |
/* |
54950 | 2 |
* Copyright (c) 2014, 2019, Oracle and/or its affiliates. All rights reserved. |
36526 | 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 |
||
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 | 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 | 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 |
* |
54950 | 45 |
* @toolGuide javadoc |
45680
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
46 |
* |
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
47 |
* @provides java.util.spi.ToolProvider |
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
48 |
* @provides javax.tools.DocumentationTool |
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
49 |
* @provides javax.tools.Tool |
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
50 |
* |
55202 | 51 |
* @see <a href="{@docRoot}/../specs/javadoc/doc-comment-spec.html"> |
45548
7db465d26194
8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents:
44452
diff
changeset
|
52 |
* Documentation Comment Specification for the Standard Doclet</a> |
7db465d26194
8180296: Move Javadoc: doclet, taglet specs to specs directory
jjg
parents:
44452
diff
changeset
|
53 |
* |
45680
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
54 |
* @moduleGraph |
6a7b5298fcf5
8181825: Add tool and services information to module summary
jjg
parents:
45548
diff
changeset
|
55 |
* @since 9 |
40507
4413083331c7
8162576: Missing doclint check missing for modules
sadayapalam
parents:
39179
diff
changeset
|
56 |
*/ |
36526 | 57 |
module jdk.javadoc { |
45684
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
58 |
requires java.xml; |
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
59 |
|
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41448
diff
changeset
|
60 |
requires transitive java.compiler; |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41448
diff
changeset
|
61 |
requires transitive jdk.compiler; |
36526 | 62 |
|
63 |
exports jdk.javadoc.doclet; |
|
64 |
||
45684
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
65 |
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
|
66 |
jdk.javadoc.internal.tool.JavadocToolProvider; |
41448 | 67 |
|
45684
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
68 |
provides javax.tools.DocumentationTool with |
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
69 |
jdk.javadoc.internal.api.JavadocTool; |
42498 | 70 |
|
45684
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
71 |
provides javax.tools.Tool with |
2c5f2779c3d1
8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents:
45680
diff
changeset
|
72 |
jdk.javadoc.internal.api.JavadocTool; |
36526 | 73 |
} |
74 |