- * @author name-text. + *
+ * @author name-text + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/CommentTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/CommentTree.java index 52c50891d3b..f7820e122fc 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/CommentTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/CommentTree.java @@ -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 @@ package com.sun.source.doctree; /** * An embedded HTML comment. * - *
- * {@literal } + *
+ * <!-- text --> + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/DeprecatedTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/DeprecatedTree.java index 7855c8989db..52764759b46 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/DeprecatedTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/DeprecatedTree.java @@ -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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @deprecated block tag. + * A tree node for an {@code @deprecated} block tag. * - *
- * @deprecated deprecated text. + *
+ * @deprecated deprecated text + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/DocCommentTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/DocCommentTree.java index e6058f3d910..ba7349b6b78 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/DocCommentTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/DocCommentTree.java @@ -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.Collections; import java.util.List; /** - * The top level representation of a documentation comment. + * The top-level representation of a documentation comment. * - *
- * first-sentence body block-tags + *
+ * first-sentence body block-tags + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/DocRootTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/DocRootTree.java index 2de83b3a1fc..4565cefd70b 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/DocRootTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/DocRootTree.java @@ -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. * - *
- * {@docroot} + *
+ * {@docroot}
+ *
*
* @since 1.8
*/
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/DocTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/DocTree.java
index a8aea66ecc1..656acffd64c 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/DocTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/DocTree.java
@@ -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 @@ public interface DocTree {
/**
* 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 @@ public interface DocTree {
/**
* Used for instances of {@link DeprecatedTree}
- * representing an @deprecated tag.
+ * representing an {@code @deprecated} tag.
*/
DEPRECATED("deprecated"),
@@ -73,7 +73,7 @@ public interface DocTree {
/**
* Used for instances of {@link DocRootTree}
- * representing an @docRoot tag.
+ * representing an {@code @docRoot} tag.
*/
DOC_ROOT("docRoot"),
@@ -103,13 +103,13 @@ public interface DocTree {
/**
* 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 @@ public interface DocTree {
/**
* 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 @@ public interface DocTree {
/**
* 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 @@ public interface DocTree {
/**
* Used for instances of {@link ThrowsTree}
- * representing an @throws tag.
+ * representing an {@code @throws} tag.
*/
THROWS("throws"),
@@ -248,19 +248,19 @@ public interface DocTree {
/**
* 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,7 +287,7 @@ public interface DocTree {
/**
* Returns the kind of this tree.
*
- * @return the kind of this tree.
+ * @return the kind of this tree
*/
Kind getKind();
@@ -295,8 +295,8 @@ public interface DocTree {
* Accept method used to implement the visitor pattern. The
* visitor pattern is used to implement operations on trees.
*
- * @param visitXyz method most applicable
* to that tree is invoked.
*
@@ -107,11 +107,11 @@ public interface DocTreeVisitor- * <!doctype text> + *
+ * <!doctype text> + *+ * + * For HTML5 documents, the correct form is {@code }. * * @since 10 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/EndElementTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/EndElementTree.java index 5015b02169e..919089c4522 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/EndElementTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/EndElementTree.java @@ -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 @@ -30,8 +30,9 @@ import javax.lang.model.element.Name; /** * A tree node for the end of an HTML element. * - *
- * </ name > + *
+ * </ name > + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/EntityTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/EntityTree.java index 57200237e84..c6dafa17cdf 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/EntityTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/EntityTree.java @@ -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 @@ -27,14 +27,14 @@ package com.sun.source.doctree; import javax.lang.model.element.Name; - /** * A tree node for an HTML entity. * - *
- * & name ;
- * & # digits ;
- * & #X hex-digits ;
+ *
+ * &name; + * &#digits; + * &#Xhex-digits; + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ErroneousTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ErroneousTree.java index 4e867e2a88e..989721b5ed1 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ErroneousTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ErroneousTree.java @@ -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 @@ -29,7 +29,7 @@ import javax.tools.Diagnostic; import javax.tools.JavaFileObject; /** - * A tree node to stand in for a malformed text + * A tree node to stand in for malformed text. * * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/HiddenTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/HiddenTree.java index 30c5a58bc66..a50d2035b5c 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/HiddenTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/HiddenTree.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2016, 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,11 +28,11 @@ package com.sun.source.doctree; import java.util.List; /** + * A tree node for an {@code @hidden} block tag. * - * A tree node for an @hidden block tag. - * - *
- * @hidden + *
+ * @hidden + ** * @since 9 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/IdentifierTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/IdentifierTree.java index a4e54b687e1..bae466215f4 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/IdentifierTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/IdentifierTree.java @@ -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 @@ -30,8 +30,9 @@ import javax.lang.model.element.Name; /** * An identifier in a documentation comment. * - *
- * name + *
+ * name + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/IndexTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/IndexTree.java index d6b5d7d1fd9..4e0d7ef75ba 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/IndexTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/IndexTree.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2015, 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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @index or @index inline tag. + * A tree node for an {@code @index} inline tag. * - *
- * {@index keyword optional description}
+ *
+ * {@index keyword optional description}
+ *
*
* @since 9
*/
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/InheritDocTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/InheritDocTree.java
index 54347d6c6f6..304bde3908f 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/InheritDocTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/InheritDocTree.java
@@ -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,11 +26,11 @@
package com.sun.source.doctree;
/**
+ * A tree node for an {@code @inheritDoc} inline tag.
*
- * A tree node for an @inheritDoc inline tag.
- *
- * - * {@inheritDoc} + *
+ * {@inheritDoc}
+ *
*
* @since 1.8
*/
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/LinkTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/LinkTree.java
index 7db7907d094..aa33338c2a7 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/LinkTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/LinkTree.java
@@ -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,17 +28,18 @@ package com.sun.source.doctree;
import java.util.List;
/**
- * A tree node for an @link or @linkplain inline tag.
+ * A tree node for an {@code @link} or {@code @linkplain} inline tag.
*
- *
- * {@link reference label}
- * {@linkplain reference label }
+ *
+ * {@link reference label}
+ * {@linkplain reference label}
+ *
*
* @since 1.8
*/
public interface LinkTree extends InlineTagTree {
/**
- * Returns the reference of a link.
+ * Returns the reference of the link.
* @return the reference
*/
ReferenceTree getReference();
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/LiteralTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/LiteralTree.java
index babd8579f55..87c4ac677e2 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/LiteralTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/LiteralTree.java
@@ -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
@@ -26,17 +26,18 @@
package com.sun.source.doctree;
/**
+ * A tree node for an {@code @literal} or {@code @code} inline tag.
*
- * A tree node for an @literal or @code inline tag.
- *
- * - * {@literal text} + *
+ * {@literal text}
+ * {@code text}
+ *
*
* @since 1.8
*/
public interface LiteralTree extends InlineTagTree {
/**
- * Returns the body of the {@code @code} or {@code @literal} tag.
+ * Returns the body of the {@code @literal} or {@code @code} tag.
* @return the body of the tag
*/
TextTree getBody();
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ParamTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ParamTree.java
index cc800cab48d..360dcbebd45 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ParamTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ParamTree.java
@@ -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,17 +28,18 @@ package com.sun.source.doctree;
import java.util.List;
/**
- * A tree node for an @param block tag.
+ * A tree node for an {@code @param} block tag.
*
- * - * @param parameter-name description + *
+ * @param parameter-name description + ** * @since 1.8 */ public interface ParamTree extends BlockTagTree { /** - * Returns true if this is documenting a type parameter. - * @return true if this is documenting a type parameter + * Returns {@code true} if this is documenting a type parameter. + * @return {@code true} if this is documenting a type parameter */ boolean isTypeParameter(); diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ProvidesTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ProvidesTree.java index f13262371d4..d0f08bbd02f 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ProvidesTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ProvidesTree.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2016, 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,11 +28,11 @@ package com.sun.source.doctree; import java.util.List; /** + * A tree node for a {@code @provides} block tag. * - * A tree node for a @provides block tag. - * - *
- * @provides service-type description + *
+ * @provides service-type description + ** * @since 9 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ReferenceTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ReferenceTree.java index 9d4c0c0970e..a8a59af2b20 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ReferenceTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ReferenceTree.java @@ -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,9 +28,10 @@ package com.sun.source.doctree; /** * A tree node for a reference to a Java language element. * - *
- * package.class#field - * package.class#method(arg-types) + *
+ * package.class#field + * package.class#method(arg-types) + ** * @since 1.8 */ @@ -38,7 +39,7 @@ public interface ReferenceTree extends DocTree { /** * Returns the signature of the Java language element being referenced, * as found in {@code @see} and similar nodes. - * @return the signature. + * @return the signature */ String getSignature(); } diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ReturnTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ReturnTree.java index 5d23903c43c..73bf87b0c69 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ReturnTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ReturnTree.java @@ -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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @return block tag. + * A tree node for an {@code @return} block tag. * - *
- * @return description + *
+ * @return description + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SeeTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SeeTree.java index ecab84d24da..1f4d1cc57b9 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SeeTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SeeTree.java @@ -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,13 +28,13 @@ package com.sun.source.doctree; import java.util.List; /** + * A tree node for an {@code @see} block tag. * - * A tree node for an @see block tag. - * - *
- * @see "string"
- * @see <a href="URL#value"> label </a>
- * @see reference
+ *
+ * @see "string" + * @see <a href="URL#value"> label </a> + * @see reference + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialDataTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialDataTree.java index 2c7ff080655..b1f93df1d3d 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialDataTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialDataTree.java @@ -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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @serialData block tag. + * A tree node for an {@code @serialData} block tag. * - *
- * @serialData data-description + *
+ * @serialData data-description + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialFieldTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialFieldTree.java index 5e0e648bb8c..78db7e0ee16 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialFieldTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialFieldTree.java @@ -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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @serialData block tag. + * A tree node for an {@code @serialField} block tag. * - *
- * @serialField field-name field-type field-description + *
+ * @serialField field-name field-type field-description + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialTree.java index 980360d1e5e..d4aa1e69285 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SerialTree.java @@ -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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @serial block tag. + * A tree node for an {@code @serial} block tag. * - *
- * @serial field-description | include | exclude + *
+ * @serial field-description | include | exclude + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SinceTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SinceTree.java index 68406a8ef04..e83c83cad85 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SinceTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SinceTree.java @@ -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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @since block tag. + * A tree node for an {@code @since} block tag. * - *
- * @since since-text + *
+ * @since since-text + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/StartElementTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/StartElementTree.java index 5731f1a7496..66c23abf449 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/StartElementTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/StartElementTree.java @@ -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 @@ -31,8 +31,9 @@ import javax.lang.model.element.Name; /** * A tree node for the start of an HTML element. * - *
- * < name [attributes] [/]> + *
+ * < name [attributes] [/]> + ** * @since 1.8 */ @@ -50,9 +51,9 @@ public interface StartElementTree extends DocTree { List getAttributes(); /** - * Returns true if this is a self-closing element, - * as indicated by a "/" before the closing ">". - * @return true if this is a self-closing element + * Returns {@code true} if this is a self-closing element, + * as indicated by a {@code "/"} before the closing {@code ">"}. + * @return {@code true} if this is a self-closing element */ boolean isSelfClosing(); } diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SummaryTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SummaryTree.java index a20cf81e34a..74136bbd76f 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SummaryTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SummaryTree.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2017, 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 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an @summary inline tag. + * A tree node for an {@code @summary} inline tag. * - *
- * {@summary text} + *
+ * {@summary text}
+ *
*
* @since 10
*/
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/SystemPropertyTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/SystemPropertyTree.java
index deb4f5d2e64..57470710439 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/SystemPropertyTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/SystemPropertyTree.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 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
@@ -25,14 +25,14 @@
package com.sun.source.doctree;
-
import javax.lang.model.element.Name;
/**
* A tree node for an {@code @systemProperty} inline tag.
*
- * - * {@systemProperty property-name} + *
+ * {@systemProperty property-name}
+ *
*
* @since 12
*/
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ThrowsTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ThrowsTree.java
index 3c4957847a1..8a58edc904a 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ThrowsTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ThrowsTree.java
@@ -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,13 +28,13 @@ package com.sun.source.doctree;
import java.util.List;
/**
+ * A tree node for an {@code @exception} or {@code @throws} block tag.
+ * {@code @exception} is a synonym for {@code @throws}.
*
- * A tree node for an @exception or @throws block tag.
- * @exception is a synonym for @throws.
- *
- *
- * @exception class-name description
- * @throws class-name description
+ *
+ * @exception class-name description + * @throws class-name description + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownBlockTagTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownBlockTagTree.java index d55a36bb96a..d12b52d2ad9 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownBlockTagTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownBlockTagTree.java @@ -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,13 +28,13 @@ package com.sun.source.doctree; import java.util.List; /** - * A tree node for an unrecognized inline tag. + * A tree node for an unrecognized block tag. * - *
- * @name content + *
+ * @name content + ** * @since 1.8 - * */ public interface UnknownBlockTagTree extends BlockTagTree { /** diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownInlineTagTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownInlineTagTree.java index 2eedb18e486..e8963f3623c 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownInlineTagTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/UnknownInlineTagTree.java @@ -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 @@ -30,11 +30,11 @@ import java.util.List; /** * A tree node for an unrecognized inline tag. * - *
- * {@name content} + *
+ * {@name content}
+ *
*
* @since 1.8
- *
*/
public interface UnknownInlineTagTree extends InlineTagTree {
/**
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/UsesTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/UsesTree.java
index 9efff438293..64d677abb5c 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/UsesTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/UsesTree.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 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,11 +28,11 @@ package com.sun.source.doctree;
import java.util.List;
/**
+ * A tree node for an {@code @uses} block tag.
*
- * A tree node for an @uses block tag.
- *
- * - * @uses service-type description + *
+ * @uses service-type description + ** * @since 9 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/ValueTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/ValueTree.java index be6be16dca0..403911d8d97 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/doctree/ValueTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/ValueTree.java @@ -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 @@ -26,10 +26,11 @@ package com.sun.source.doctree; /** - * A tree node for an @value inline tag. + * A tree node for an {@code @value} inline tag. * - *
- * { @value reference } + *
+ * {@value reference}
+ *
*
* @since 1.8
*/
diff --git a/src/jdk.compiler/share/classes/com/sun/source/doctree/VersionTree.java b/src/jdk.compiler/share/classes/com/sun/source/doctree/VersionTree.java
index 41cc20ed380..db40be4c941 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/doctree/VersionTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/doctree/VersionTree.java
@@ -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,11 +28,11 @@ package com.sun.source.doctree;
import java.util.List;
/**
+ * A tree node for an {@code @version} block tag.
*
- * A tree node for an @version block tag.
- *
- * - * @version version-text + *
+ * @version version-text + ** * @since 1.8 */ diff --git a/src/jdk.compiler/share/classes/com/sun/source/tree/ConditionalExpressionTree.java b/src/jdk.compiler/share/classes/com/sun/source/tree/ConditionalExpressionTree.java index ac0782599bc..4b59404fb27 100644 --- a/src/jdk.compiler/share/classes/com/sun/source/tree/ConditionalExpressionTree.java +++ b/src/jdk.compiler/share/classes/com/sun/source/tree/ConditionalExpressionTree.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 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,7 +26,7 @@ package com.sun.source.tree; /** - * A tree node for the conditional operator ? :. + * A tree node for the conditional operator {@code ? :}. * * For example: *
diff --git a/src/jdk.compiler/share/classes/com/sun/source/tree/InstanceOfTree.java b/src/jdk.compiler/share/classes/com/sun/source/tree/InstanceOfTree.java
index 89dc558a0f6..1d501c5678b 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/tree/InstanceOfTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/tree/InstanceOfTree.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -76,7 +76,7 @@ public interface InstanceOfTree extends ExpressionTree {
*
* returns null.
*
- * @return the tested pattern, or null if this instanceof does not use a pattern.
+ * @return the tested pattern, or null if this instanceof does not use a pattern
* @since 14
*/
PatternTree getPattern();
diff --git a/src/jdk.compiler/share/classes/com/sun/source/tree/MemberSelectTree.java b/src/jdk.compiler/share/classes/com/sun/source/tree/MemberSelectTree.java
index 34156951bee..bf830026101 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/tree/MemberSelectTree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/tree/MemberSelectTree.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -46,7 +46,7 @@ import javax.lang.model.element.Name;
public interface MemberSelectTree extends ExpressionTree {
/**
* Returns the expression for which a member is to be selected.
- * @return the expression.
+ * @return the expression
*/
ExpressionTree getExpression();
diff --git a/src/jdk.compiler/share/classes/com/sun/source/tree/Tree.java b/src/jdk.compiler/share/classes/com/sun/source/tree/Tree.java
index 79899ef6ca6..f368973b550 100644
--- a/src/jdk.compiler/share/classes/com/sun/source/tree/Tree.java
+++ b/src/jdk.compiler/share/classes/com/sun/source/tree/Tree.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -708,7 +708,7 @@ public interface Tree {
/**
* Returns the kind of this tree.
*
- * @return the kind of this tree.
+ * @return the kind of this tree
*/
Kind getKind();
@@ -716,8 +716,8 @@ public interface Tree {
* Accept method used to implement the visitor pattern. The
* visitor pattern is used to implement operations on trees.
*
- * @param
- * {@code tree.getStartPosition() <= tree.getEndPosition()} or
+ * {@code tree.getStartPosition() <= tree.getEndPosition()} or
* {@code tree.getStartPosition() == NOPOS} or
* {@code tree.getEndPosition() == NOPOS}
*
- * {@code tree.getStartPosition() <= tree.getEndPosition()} or
+ * {@code tree.getStartPosition() <= tree.getEndPosition()} or
* {@code tree.getStartPosition() == NOPOS} or
* {@code tree.getEndPosition() == NOPOS}
*
This is NOT part of any supported API.
@@ -52,9 +51,9 @@ public class LazyDocCommentTable implements DocCommentTable {
}
}
- ParserFactory fac;
- DiagnosticSource diagSource;
- Map This is NOT part of any supported API.
@@ -43,8 +43,8 @@ public interface InheritableTaglet extends Taglet {
* object, set its values with the appropriate information to inherit
* documentation.
*
- * @param input the input for documentation search.
- * @param output the output for documentation search.
+ * @param input the input for documentation search
+ * @param output the output for documentation search
*/
void inherit(DocFinder.Input input, DocFinder.Output output);
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SimpleTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SimpleTaglet.java
index bea3ad6964a..d0ec029aaa8 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SimpleTaglet.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SimpleTaglet.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 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
@@ -40,7 +40,7 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFinder;
import jdk.javadoc.internal.doclets.toolkit.util.Utils;
/**
- * A simple single argument custom tag.
+ * A custom single-argument tag.
*
* This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
@@ -57,8 +57,8 @@ public class SimpleTaglet extends BaseTaglet implements InheritableTaglet {
/**
* Whether or not the taglet should generate output.
- * Standard tags like at-author, at-since, at-version can be disabled
- * by command-line options; custom tags created with -tag can be
+ * Standard tags like {@code @author}, {@code @since}, {@code @version} can
+ * be disabled by command-line options; custom tags created with -tag can be
* disabled with an X in the defining string.
*/
protected final boolean enabled;
@@ -71,7 +71,7 @@ public class SimpleTaglet extends BaseTaglet implements InheritableTaglet {
* @param locations the possible locations that this tag can appear in
* The string can contain 'p' for package, 't' for type,
* 'm' for method, 'c' for constructor and 'f' for field.
- * See {@linbk #getLocations(String) getLocations} for the
+ * See {@link #getLocations(String) getLocations} for the
* complete list.
*/
public SimpleTaglet(String tagName, String header, String locations) {
@@ -83,18 +83,17 @@ public class SimpleTaglet extends BaseTaglet implements InheritableTaglet {
*
* @param tagKind the kind of this tag
* @param header the header to output
- * @param locations the possible locations that this tag can appear in.
+ * @param locations the possible locations that this tag can appear in
*/
public SimpleTaglet(DocTree.Kind tagKind, String header, Set This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.
*/
-public class UserTaglet implements Taglet {
+public final class UserTaglet implements Taglet {
private final jdk.javadoc.doclet.Taglet userTaglet;
@@ -95,11 +95,6 @@ public class UserTaglet implements Taglet {
return userTaglet.getAllowedLocations().contains(TYPE);
}
- /**
- * Return true if this Taglet
- * is used in field documentation.
- * @return true if this Taglet
- * is used in field documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in field documentation.
+ *
+ * @return {@code true} if this {@code Taglet} can be used in field documentation
+ * and {@code false} otherwise
*/
boolean inField();
/**
- * Return true if this Taglet
- * is used in constructor documentation.
- * @return true if this Taglet
- * is used in constructor documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in constructor documentation.
+ *
+ * @return {@code true} if this {@code Taglet} can be used in constructor documentation
+ * and {@code false} otherwise
*/
boolean inConstructor();
/**
- * Return true if this Taglet
- * is used in method documentation.
- * @return true if this Taglet
- * is used in method documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in method documentation.
+ *
+ * @return {@code true} if this {@code Taglet} can be used in method documentation
+ * and {@code false} otherwise
*/
boolean inMethod();
/**
- * Return true if this Taglet
- * is used in overview documentation.
- * @return true if this Taglet
- * is used in method documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in overview documentation.
+ *
+ * @return {@code true} if this {@code Taglet} can be used in overview documentation
+ * and {@code false} otherwise
*/
boolean inOverview();
/**
- * Return true if this Taglet
- * is used in module documentation.
- * @return true if this Taglet
- * is used in module documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in module documentation.
+ *
+ * @return {@code true} if this {@code Taglet} can be used in module documentation
+ * and {@code false} otherwise
*/
boolean inModule();
/**
- * Return true if this Taglet
- * is used in package documentation.
- * @return true if this Taglet
- * is used in package documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in package documentation.
+ *
+ * @return {@code true} if this {@code Taglet} can be used in package documentation
+ * and {@code false} otherwise
*/
boolean inPackage();
/**
- * Return true if this Taglet
- * is used in type documentation (classes or
- * interfaces).
- * @return true if this Taglet
- * is used in type documentation and false
- * otherwise.
+ * Indicates whether this {@code Taglet} can be used in type documentation (classes or interfaces).
+ *
+ * @return {@code true} if this {@code Taglet} can be used in type documentation
+ * and {@code false} otherwise
*/
boolean inType();
/**
- * Return true if this Taglet
- * is an inline tag. Return false otherwise.
- * @return true if this Taglet
- * is an inline tag and false otherwise.
+ * Indicates whether this {@code Taglet} represents an inline tag.
+ *
+ * @return {@code true} if this {@code Taglet} represents an inline tag
+ * and {@code false} otherwise
*/
boolean isInlineTag();
/**
- * Indicates whether this taglet supports block tags.
+ * Indicates whether this {@code Taglet} represents a block tag.
*
- * @return true if this taglet supports block tags
+ * @return {@code true} if this {@code Taglet} represents a block tag
* @implSpec This implementation returns the inverse
* result to {@code isInlineTag}.
*/
@@ -129,8 +120,8 @@ public interface Taglet {
}
/**
- * Return the name of this custom tag.
- * @return the name of this custom tag.
+ * Returns the name of this tag.
+ * @return the name of this tag
*/
String getName();
@@ -148,8 +139,8 @@ public interface Taglet {
UnsupportedTagletOperationException;
/**
- * Returns the content to be included in the generated output for all
- * instances of tags handled by this taglet.
+ * Returns the content to be included in the generated output for
+ * instances of a tag handled by this taglet.
*
* @param element the element for the enclosing doc comment
* @param writer the taglet-writer used in this doclet
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java
index 1c5ceed5679..057a1583f2c 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletManager.java
@@ -131,8 +131,8 @@ public class TagletManager {
/**
* Keep track of standard tags in lowercase to compare for better
- * error messages when a tag like @docRoot is mistakenly spelled
- * lowercase @docroot.
+ * error messages when a tag like {@code @docRoot} is mistakenly spelled
+ * lowercase {@code @docroot}.
*/
private final SetTaglet is an inline tag.
- *
- * @return true if this Taglet is an inline tag and false otherwise.
- */
@Override
public boolean isInlineTag() {
return userTaglet.isInlineTag();
@@ -116,7 +111,7 @@ public class UserTaglet implements Taglet {
}
@Override
- public Content getTagletOutput(Element element, DocTree tag, TagletWriter writer){
+ public Content getTagletOutput(Element element, DocTree tag, TagletWriter writer) {
Content output = writer.getOutputInstance();
output.add(new RawHtml(userTaglet.toString(Collections.singletonList(tag), element)));
return output;
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java
index 57e2f20a236..f0b061335b4 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java
@@ -875,7 +875,7 @@ public class Utils {
/*
* We should not instantiate if (i) there's no contextual type declaration, (ii) the declaration
* to which the member belongs to is the same as the one under consideration, (iii) if the
- * delcaration to which the member belongs to is not generic.
+ * declaration to which the member belongs to is not generic.
*/
private boolean shouldInstantiate(TypeElement site, Element e) {
return site != null &&
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberCache.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberCache.java
index f85674bed89..39494eb565b 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberCache.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberCache.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 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,8 @@ package jdk.javadoc.internal.doclets.toolkit.util;
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
import javax.lang.model.element.TypeElement;
-import javax.lang.model.type.TypeMirror;
import java.util.HashMap;
import java.util.Map;
-import java.util.regex.Pattern;
/**
* This class manages the visible member table for each type element.
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocMemberEnter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocMemberEnter.java
index 6c5b0ea5587..efd1aa4b959 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocMemberEnter.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocMemberEnter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 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
@@ -34,7 +34,6 @@ import com.sun.tools.javac.tree.JCTree.*;
import com.sun.tools.javac.tree.TreeInfo;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.List;
-import com.sun.tools.javac.util.Names;
import static com.sun.tools.javac.code.Flags.*;
import static com.sun.tools.javac.code.Kinds.Kind.*;