Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
8251550: Clean up jdk.javadoc and the related parts of jdk.compiler
Reviewed-by: jjg
  • Loading branch information
pavelrappo committed Aug 18, 2020
1 parent 607b761 commit 238859091104d727d7a3b0df2f12abf2c9440a95
Show file tree
Hide file tree
Showing 80 changed files with 581 additions and 632 deletions.
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -56,13 +56,14 @@ enum ValueKind {

/**
* Returns the kind of the attribute.
* @return the kind of the attribute.
* @return the kind of the attribute
*/
ValueKind getValueKind();

/**
* Returns the value of the attribute, or {@code null} if the kind is EMPTY.
* @return the value of the attribute.
* Returns the value of the attribute, or {@code null} if the
* {@linkplain #getValueKind() kind of this attribute} is {@code EMPTY}.
* @return the value of the attribute
*/
List<? extends DocTree> getValue();
}
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -28,10 +28,11 @@
import java.util.List;

/**
* A tree node for an @author block tag.
* A tree node for an {@code @author} block tag.
*
* <p>
* &#064;author name-text.
* <pre>
* &#064;author name-text
* </pre>
*
* @since 1.8
*/
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -28,8 +28,9 @@
/**
* An embedded HTML comment.
*
* <p>
* {@literal <!-- text --> }
* <pre>
* &lt;!-- text --&gt;
* </pre>
*
* @since 1.8
*/
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -28,10 +28,11 @@
import java.util.List;

/**
* A tree node for an @deprecated block tag.
* A tree node for an {@code @deprecated} block tag.
*
* <p>
* &#064;deprecated deprecated text.
* <pre>
* &#064;deprecated deprecated text
* </pre>
*
* @since 1.8
*/
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -30,10 +30,11 @@
import java.util.List;

/**
* The top level representation of a documentation comment.
* The top-level representation of a documentation comment.
*
* <p>
* first-sentence body block-tags
* <pre>
* first-sentence body block-tags
* </pre>
*
* @since 1.8
*/
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -26,10 +26,11 @@
package com.sun.source.doctree;

/**
* A tree node for an @docroot inline tag.
* A tree node for an {@code @docroot} inline tag.
*
* <p>
* {&#064;docroot}
* <pre>
* {&#064;docroot}
* </pre>
*
* @since 1.8
*/
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2011, 2020, 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
@@ -43,13 +43,13 @@ enum Kind {

/**
* Used for instances of {@link AuthorTree}
* representing an @author tag.
* representing an {@code @author} tag.
*/
AUTHOR("author"),

/**
* Used for instances of {@link LiteralTree}
* representing an @code tag.
* representing an {@code @code} tag.
*/
CODE("code"),

@@ -61,7 +61,7 @@ enum Kind {

/**
* Used for instances of {@link DeprecatedTree}
* representing an @deprecated tag.
* representing an {@code @deprecated} tag.
*/
DEPRECATED("deprecated"),

@@ -73,7 +73,7 @@ enum Kind {

/**
* Used for instances of {@link DocRootTree}
* representing an @docRoot tag.
* representing an {@code @docRoot} tag.
*/
DOC_ROOT("docRoot"),

@@ -103,13 +103,13 @@ enum Kind {

/**
* Used for instances of {@link ThrowsTree}
* representing an @exception tag.
* representing an {@code @exception} tag.
*/
EXCEPTION("exception"),

/**
* Used for instances of {@link HiddenTree}
* representing an @hidden tag.
* representing an {@code @hidden} tag.
*/
HIDDEN("hidden"),

@@ -121,86 +121,86 @@ enum Kind {

/**
* Used for instances of {@link IndexTree}
* representing a search term.
* representing an {@code @index} tag.
*/
INDEX("index"),

/**
* Used for instances of {@link InheritDocTree}
* representing an @inheritDoc tag.
* representing an {@code @inheritDoc} tag.
*/
INHERIT_DOC("inheritDoc"),

/**
* Used for instances of {@link LinkTree}
* representing an @link tag.
* representing an {@code @link} tag.
*/
LINK("link"),

/**
* Used for instances of {@link LinkTree}
* representing an @linkplain tag.
* representing an {@code @linkplain} tag.
*/
LINK_PLAIN("linkplain"),

/**
* Used for instances of {@link LiteralTree}
* representing an @literal tag.
* representing an {@code @literal} tag.
*/
LITERAL("literal"),

/**
* Used for instances of {@link ParamTree}
* representing an @param tag.
* representing an {@code @param} tag.
*/
PARAM("param"),

/**
* Used for instances of {@link ProvidesTree}
* representing an @provides tag.
* representing an {@code @provides} tag.
*/
PROVIDES("provides"),

/**
* Used for instances of {@link ReferenceTree}
* representing a reference to a element in the
* representing a reference to an element in the
* Java programming language.
*/
REFERENCE,

/**
* Used for instances of {@link ReturnTree}
* representing an @return tag.
* representing an {@code @return} tag.
*/
RETURN("return"),

/**
* Used for instances of {@link SeeTree}
* representing an @see tag.
* representing an {@code @see} tag.
*/
SEE("see"),

/**
* Used for instances of {@link SerialTree}
* representing an @serial tag.
* representing an {@code @serial} tag.
*/
SERIAL("serial"),

/**
* Used for instances of {@link SerialDataTree}
* representing an @serialData tag.
* representing an {@code @serialData} tag.
*/
SERIAL_DATA("serialData"),

/**
* Used for instances of {@link SerialFieldTree}
* representing an @serialField tag.
* representing an {@code @serialField} tag.
*/
SERIAL_FIELD("serialField"),

/**
* Used for instances of {@link SinceTree}
* representing an @since tag.
* representing an {@code @since} tag.
*/
SINCE("since"),

@@ -212,13 +212,13 @@ enum Kind {

/**
* Used for instances of {@link SystemPropertyTree}
* representing an @systemProperty tag.
* representing an {@code @systemProperty} tag.
*/
SYSTEM_PROPERTY("systemProperty"),

/**
* Used for instances of {@link SummaryTree}
* representing the summary of a comment description.
* representing an {@code @summary} tag.
*/
SUMMARY("summary"),

@@ -230,7 +230,7 @@ enum Kind {

/**
* Used for instances of {@link ThrowsTree}
* representing an @throws tag.
* representing an {@code @throws} tag.
*/
THROWS("throws"),

@@ -248,19 +248,19 @@ enum Kind {

/**
* Used for instances of {@link UsesTree}
* representing an @uses tag.
* representing an {@code @uses} tag.
*/
USES("uses"),

/**
* Used for instances of {@link ValueTree}
* representing an @value tag.
* representing an {@code @value} tag.
*/
VALUE("value"),

/**
* Used for instances of {@link VersionTree}
* representing an @version tag.
* representing an {@code @version} tag.
*/
VERSION("version"),

@@ -287,16 +287,16 @@ enum Kind {
/**
* Returns the kind of this tree.
*
* @return the kind of this tree.
* @return the kind of this tree
*/
Kind getKind();

/**
* Accept method used to implement the visitor pattern. The
* visitor pattern is used to implement operations on trees.
*
* @param <R> result type of this operation.
* @param <D> type of additional data.
* @param <R> the result type of this operation
* @param <D> the type of additional data
* @param visitor the visitor to be called
* @param data a parameter value to be passed to the visitor method
* @return the value returned from the visitor method

0 comments on commit 2388590

Please sign in to comment.