8305004: add @spec tags to langtools modules

Reviewed-by: iris
This commit is contained in:
Jonathan Gibbons 2023-03-28 14:52:22 +00:00
parent 32ef452132
commit 83ce65e12c
6 changed files with 7 additions and 6 deletions
src
java.compiler/share/classes/javax
annotation/processing
tools
jdk.compiler/share/classes/com/sun/source
jdk.javadoc/share/classes

@ -123,6 +123,7 @@ import java.io.IOException;
* annotation if the environment is configured so that that class or
* interface is accessible.
*
* @spec https://www.rfc-editor.org/info/rfc3986 RFC 3986: RFC 3986: Uniform Resource Identifier (URI): Generic Syntax
* @apiNote Some of the effect of overwriting a file can be
* achieved by using a <i>decorator</i>-style pattern. Instead of
* modifying a class directly, the class is designed so that either

@ -103,6 +103,7 @@ import static javax.tools.JavaFileObject.Kind;
* <p>Unless explicitly allowed, all methods in this interface might
* throw a NullPointerException if given a {@code null} argument.
*
* @spec https://www.rfc-editor.org/info/rfc3986 RFC 3986: RFC 3986: Uniform Resource Identifier (URI): Generic Syntax
* @see JavaFileObject
* @see FileObject
* @since 1.6

@ -27,10 +27,9 @@
* Provides interfaces to represent documentation comments as abstract syntax
* trees (AST).
*
* @spec javadoc/doc-comment-spec.html Documentation Comment Specification for the Standard Doclet
* @author Jonathan Gibbons
* @since 1.8
*
* @see <a href="{@docRoot}/../specs/javadoc/doc-comment-spec.html">
* Documentation Comment Specification for the Standard Doclet</a>
*/
package com.sun.source.doctree;

@ -249,6 +249,7 @@ public abstract class DocTrees extends Trees {
*
* @param tree the tree containing the entity
* @return a string containing the characters
* @spec https://www.w3.org/TR/html52 HTML Standard
*/
public abstract String getCharacters(EntityTree tree);
}

@ -63,8 +63,8 @@ import jdk.javadoc.internal.doclets.formats.html.HtmlDoclet;
* of {@code <dt>} and {@code <dd>} elements.
* </dl>
*
* @see <a href="{@docRoot}/../specs/javadoc/doc-comment-spec.html">
* Documentation Comment Specification for the Standard Doclet</a>
@spec javadoc/doc-comment-spec.html Documentation Comment Specification for the Standard Doclet
@spec https://www.w3.org/TR/html52 HTML Standard
*/
public class StandardDoclet implements Doclet {

@ -42,6 +42,7 @@
* or the {@linkplain java.util.ServiceLoader service loader} with the name
* {@code "javadoc"}.
*
* @spec javadoc/doc-comment-spec.html Documentation Comment Specification for the Standard Doclet
* @toolGuide javadoc
*
* @provides java.util.spi.ToolProvider
@ -51,8 +52,6 @@
* @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