diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Taglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Taglet.java index 4a1bbd2f79a..b8b9132f6cd 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Taglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Taglet.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2001, 2022, 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 @@ -75,7 +75,6 @@ import com.sun.source.doctree.DocTree; * for the Standard Doclet * @since 9 */ - public interface Taglet { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/package-info.java index 3658ed74d85..51b83540e51 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/package-info.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2015, 2022, 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 @@ -379,6 +379,5 @@ * @see jdk.javadoc.doclet.Doclet * @see jdk.javadoc.doclet.DocletEnvironment * @since 9 -*/ - + */ package jdk.javadoc.doclet; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/package-info.java index 3f8437bbfc6..86e8224a12c 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/api/package-info.java @@ -24,8 +24,8 @@ */ /** - * This package provides the javadoc implementation of relevant - * public API defined in {@link javax.tools}, which provides an - * API alternative to invoking javadoc via the command line. + * This package provides the javadoc implementation of relevant + * public API defined in {@link javax.tools}, which provides an + * API alternative to invoking javadoc via the command line. */ package jdk.javadoc.internal.api; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MarkerComments.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MarkerComments.java index 703b3b7131b..04888d7cc2f 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MarkerComments.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/MarkerComments.java @@ -28,7 +28,7 @@ package jdk.javadoc.internal.doclets.formats.html; import jdk.javadoc.internal.doclets.formats.html.markup.Comment; /** - * Marker comments to identify regions in the generated files. + * Marker comments to identify regions in the generated files. */ public class MarkerComments { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java index 26d0ad4b117..8443a7cf153 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SerializedFormWriterImpl.java @@ -43,7 +43,7 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; import jdk.javadoc.internal.doclets.toolkit.util.IndexItem; /** - * Generates the Serialized Form Information Page, serialized-form.html. + * Generates the Serialized Form Information Page, serialized-form.html. */ public class SerializedFormWriterImpl extends SubWriterHolderWriter implements SerializedFormWriter { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java index ae3ffd36d76..a215871a15d 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java @@ -81,7 +81,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils.PreviewFlagProvider; /** * The taglet writer that writes HTML. */ - public class TagletWriterImpl extends TagletWriter { /** * A class that provides the information about the enclosing context for diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java index 4301db9283a..dd4b50eb760 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/DocType.java @@ -26,7 +26,7 @@ package jdk.javadoc.internal.doclets.formats.html.markup; /** - * Supported DOCTYPE declarations. + * Supported DOCTYPE declarations. */ public enum DocType { HTML5(""); diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java index 017207ed7e2..ada13073787 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java @@ -901,8 +901,8 @@ public enum HtmlStyle { externalLink, /** - * The class of a {@code section} element containing a hierarchical - * tree view. + * The class of a {@code section} element containing a hierarchical + * tree view. */ hierarchy, diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/package-info.java index c86b8b8d2a8..aa279972f8c 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/package-info.java @@ -24,14 +24,14 @@ */ /** - * This package contains classes that create and write HTML markup tags. + * This package contains classes that create and write HTML markup tags. * - *

The primary low level classes are - * {@link jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree HtmlTree} - * and other subtypes of {@code Content}. In addition, there are mid-level builders - * like {@link jdk.javadoc.internal.doclets.formats.html.TableHeader TableHeader} - * and {@link jdk.javadoc.internal.doclets.formats.html.Table Table} - * to help build more complex HTML trees. + *

The primary low level classes are + * {@link jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree HtmlTree} + * and other subtypes of {@code Content}. In addition, there are mid-level builders + * like {@link jdk.javadoc.internal.doclets.formats.html.TableHeader TableHeader} + * and {@link jdk.javadoc.internal.doclets.formats.html.Table Table} + * to help build more complex HTML trees. * * @see HTML: Living Standard * @see HTML: Living Standard: The HTML Syntax diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/package-info.java index b5383a5ea2d..647454a75a8 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/package-info.java @@ -23,12 +23,11 @@ * questions. */ - /** - * The set of low-level file-formats, to be used in conjunction with - * the {@link jdk.javadoc.internal.doclets.toolkit doclets.toolkit} API. + * The set of low-level file-formats, to be used in conjunction with + * the {@link jdk.javadoc.internal.doclets.toolkit doclets.toolkit} API. * - *

Currently, only {@link jdk.javadoc.internal.doclets.formats.html HTML} - * format is supported. + *

Currently, only {@link jdk.javadoc.internal.doclets.formats.html HTML} + * format is supported. */ package jdk.javadoc.internal.doclets.formats; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/package-info.java index aed1ce235bc..256cf2da508 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/package-info.java @@ -24,20 +24,19 @@ */ /** - * Doclets provide the user-selectable back ends for processing the - * documentation comments in Java source code. + * Doclets provide the user-selectable back ends for processing the + * documentation comments in Java source code. * - *

Doclets are implementations of the {@link jdk.javadoc.doclet Doclet API}.

+ *

Doclets are implementations of the {@link jdk.javadoc.doclet Doclet API}.

* - *

Currently, there is only one supported doclet, the - * {@link jdk.javadoc.internal.doclets.formats.html.HtmlDoclet HtmlDoclet}, - * for writing API documentation in HTML. Nevertheless, in order to - * separate the high-level code for the general content of each page - * from the low-level details of how to write such content, the code is - * organized in two sections: a format-neutral - * {@link jdk.javadoc.internal.doclets.toolkit toolkit API}, - * and a specific {@link jdk.javadoc.internal.doclets.formats format}, - * such as {@link jdk.javadoc.internal.doclets.formats.html HTML format}. -*/ - + *

Currently, there is only one supported doclet, the + * {@link jdk.javadoc.internal.doclets.formats.html.HtmlDoclet HtmlDoclet}, + * for writing API documentation in HTML. Nevertheless, in order to + * separate the high-level code for the general content of each page + * from the low-level details of how to write such content, the code is + * organized in two sections: a format-neutral + * {@link jdk.javadoc.internal.doclets.toolkit toolkit API}, + * and a specific {@link jdk.javadoc.internal.doclets.formats format}, + * such as {@link jdk.javadoc.internal.doclets.formats.html HTML format}. + */ package jdk.javadoc.internal.doclets; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AnnotationTypeMemberWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AnnotationTypeMemberWriter.java index 36ec5716f26..685b6e9a1b5 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AnnotationTypeMemberWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/AnnotationTypeMemberWriter.java @@ -30,7 +30,6 @@ import javax.lang.model.element.Element; /** * The interface for writing annotation type required member output. */ - public interface AnnotationTypeMemberWriter extends MemberWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java index 4d3f3ffcc07..3ac1f05bd26 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java @@ -32,7 +32,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; /** * The interface for writing class output. */ - public interface ClassWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/CommentUtils.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/CommentUtils.java index 9cecbe42877..0aa676e63da 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/CommentUtils.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/CommentUtils.java @@ -66,7 +66,7 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils; import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable; /** - * A utility class for handling documentation comments. + * A utility class for handling documentation comments. */ public class CommentUtils { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java index 267614ad8e2..0286b6e85c8 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstantsSummaryWriter.java @@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; /** * The interface for writing constants summary output. */ - public interface ConstantsSummaryWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstructorWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstructorWriter.java index befd5a08e63..9086d7f371a 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstructorWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ConstructorWriter.java @@ -30,7 +30,6 @@ import javax.lang.model.element.ExecutableElement; /** * The interface for writing constructor output. */ - public interface ConstructorWriter extends MemberWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocFilesHandler.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocFilesHandler.java index 40dfad68af9..dbd830a82c6 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocFilesHandler.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/DocFilesHandler.java @@ -29,10 +29,10 @@ package jdk.javadoc.internal.doclets.toolkit; import java.util.List; import jdk.javadoc.internal.doclets.toolkit.util.DocPath; + /** * The interface for copying doc-files to the output. */ - public interface DocFilesHandler { void copyDocFiles() throws DocletException; List getStylesheets() throws DocletException; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/EnumConstantWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/EnumConstantWriter.java index 878560a67a8..83824ad4935 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/EnumConstantWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/EnumConstantWriter.java @@ -31,7 +31,6 @@ import javax.lang.model.element.VariableElement; /** * The interface for writing enum constant output. */ - public interface EnumConstantWriter extends MemberWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/FieldWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/FieldWriter.java index 1c17e386ed7..85db6e674fc 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/FieldWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/FieldWriter.java @@ -27,11 +27,9 @@ package jdk.javadoc.internal.doclets.toolkit; import javax.lang.model.element.VariableElement; - /** * The interface for writing field output. */ - public interface FieldWriter extends MemberWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MemberSummaryWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MemberSummaryWriter.java index 455da1531ab..34c2f9810db 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MemberSummaryWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MemberSummaryWriter.java @@ -35,7 +35,6 @@ import com.sun.source.doctree.DocTree; /** * The interface for writing member summary output. */ - public interface MemberSummaryWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MethodWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MethodWriter.java index b1e0b6be0b0..3483849195a 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MethodWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/MethodWriter.java @@ -31,7 +31,6 @@ import javax.lang.model.type.TypeMirror; /** * The interface for writing method output. */ - public interface MethodWriter extends MemberWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java index b5d98744b02..b987b457aa1 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ModuleSummaryWriter.java @@ -30,7 +30,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; /** * The interface for writing module summary output. */ - public interface ModuleSummaryWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/NestedClassWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/NestedClassWriter.java index 7e9c16a5171..5590112dde4 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/NestedClassWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/NestedClassWriter.java @@ -28,6 +28,5 @@ package jdk.javadoc.internal.doclets.toolkit; /** * The interface for writing class output. */ - public interface NestedClassWriter { } diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PackageSummaryWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PackageSummaryWriter.java index 1454d8f4a3e..9716178b21b 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PackageSummaryWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PackageSummaryWriter.java @@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; /** * The interface for writing package summary output. */ - public interface PackageSummaryWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PropertyWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PropertyWriter.java index a6fdc1b8d64..24bb3052cae 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PropertyWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/PropertyWriter.java @@ -30,7 +30,6 @@ import javax.lang.model.element.ExecutableElement; /** * The interface for writing property output. */ - public interface PropertyWriter extends MemberWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java index fa4415f8cec..bdf0a703333 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/SerializedFormWriter.java @@ -37,7 +37,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; /** * The interface for writing serialized form output. */ - public interface SerializedFormWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WriterFactory.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WriterFactory.java index edd17a4ce73..0b007db7f7e 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WriterFactory.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WriterFactory.java @@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable; /** * The interface for a factory creates writers. */ - public interface WriterFactory { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java index 20ca55164dd..d6c87a63e09 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java @@ -47,7 +47,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils; * do is implement the ConstantsSummaryWriter interface and pass it to the * builder using a WriterFactory. */ - public abstract class AbstractBuilder { public static class Context { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/BuilderFactory.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/BuilderFactory.java index b98ff23c41a..e1710f3ca0f 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/BuilderFactory.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/BuilderFactory.java @@ -41,7 +41,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.ClassTree; /** * The factory for constructing builders. */ - public class BuilderFactory { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/package-info.java index 26dc369e91b..6dd739b0bcd 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/package-info.java @@ -24,12 +24,12 @@ */ /** - * This doclet-independent package has a set of classes and - * interfaces that are the building blocks for doclets. They - * define the basic structure of doclets and make doclet - * writing much easier because they provide the content generation - * code to be shared among different doclets. Builders only provide - * the structure and content of API documentation. - * They do not directly provide any style markup. + * This doclet-independent package has a set of classes and + * interfaces that are the building blocks for doclets. They + * define the basic structure of doclets and make doclet + * writing much easier because they provide the content generation + * code to be shared among different doclets. Builders only provide + * the structure and content of API documentation. + * They do not directly provide any style markup. */ package jdk.javadoc.internal.doclets.toolkit.builders; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/package-info.java index b3d69af9ce5..8258e96e40c 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/package-info.java @@ -24,9 +24,8 @@ */ /** - Contains the base classes that make up a doclet. Doclets that reuse - the functionality provided by the toolkit should have the following - characteristics: -*/ - + * Contains the base classes that make up a doclet. Doclets that reuse + * the functionality provided by the toolkit should have the following + * characteristics: + */ package jdk.javadoc.internal.doclets.toolkit; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/CodeTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/CodeTaglet.java index 16f75bf7bc8..f8abba91fd8 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/CodeTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/CodeTaglet.java @@ -45,7 +45,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; * displays as: *

The type {@code List

}

*/ - public class CodeTaglet extends BaseTaglet { CodeTaglet() { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DeprecatedTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DeprecatedTaglet.java index 879313cc451..b91a1dda771 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DeprecatedTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DeprecatedTaglet.java @@ -35,7 +35,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; /** * A taglet that represents the @deprecated tag. */ - public class DeprecatedTaglet extends BaseTaglet { public DeprecatedTaglet() { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DocRootTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DocRootTaglet.java index 99ad7c73c75..f7a174e2f46 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DocRootTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/DocRootTaglet.java @@ -37,7 +37,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; * used to get the relative path to the document's root output * directory. */ - public class DocRootTaglet extends BaseTaglet { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/IndexTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/IndexTaglet.java index d67cb44f003..c4be95c3f86 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/IndexTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/IndexTaglet.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2015, 2022, 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 @@ -38,7 +38,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; * The enclosed text is interpreted as not containing HTML markup or * nested javadoc tags. */ - public class IndexTaglet extends BaseTaglet { IndexTaglet() { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/InheritDocTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/InheritDocTaglet.java index 5a073e63709..730e6444346 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/InheritDocTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/InheritDocTaglet.java @@ -44,7 +44,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils; * be used with a method. It is used to inherit documentation from overridden * and implemented methods. */ - public class InheritDocTaglet extends BaseTaglet { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/LiteralTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/LiteralTaglet.java index 3e2ffa2fd12..0e80d31b9a1 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/LiteralTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/LiteralTaglet.java @@ -32,6 +32,7 @@ import com.sun.source.doctree.DocTree; import com.sun.source.doctree.LiteralTree; import jdk.javadoc.doclet.Taglet.Location; import jdk.javadoc.internal.doclets.toolkit.Content; + /** * An inline Taglet used to denote literal text. * For example, the text: @@ -39,7 +40,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; * displays as: *
{@literal ac}
*/ - public class LiteralTaglet extends BaseTaglet { LiteralTaglet() { 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 7da056a3f79..bd65ed2ae93 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 @@ -42,7 +42,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils; /** * A custom single-argument block tag. */ - public class SimpleTaglet extends BaseTaglet implements InheritableTaglet { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SummaryTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SummaryTaglet.java index 149debda2a9..23a9102305f 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SummaryTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SummaryTaglet.java @@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; /** * A taglet that represents the @summary tag. */ - public class SummaryTaglet extends BaseTaglet { public SummaryTaglet() { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SystemPropertyTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SystemPropertyTaglet.java index 0c3c53e9e22..5bc4536edb6 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SystemPropertyTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SystemPropertyTaglet.java @@ -36,7 +36,6 @@ import java.util.EnumSet; /** * A taglet that represents the {@code @systemProperty} tag. */ - public class SystemPropertyTaglet extends BaseTaglet { SystemPropertyTaglet(){ diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/Taglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/Taglet.java index 74da3d25929..bf2660acfd9 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/Taglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/Taglet.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2003, 2022, 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 @@ -35,7 +35,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content; /** * This is the Taglet interface used internally within the doclet. */ - public interface Taglet { /** * Returns the set of allowed locations for a block tag handled by this taglet. 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 a77beec74e1..b19c1f87077 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 @@ -83,7 +83,6 @@ import static javax.tools.DocumentationTool.Location.TAGLET_PATH; /** * Manages the {@code Taglet}s used by doclets. */ - public class TagletManager { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java index 0fd4fc81fd1..b5fd7931f10 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/TagletWriter.java @@ -53,7 +53,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils; /** * The interface for the taglet writer. */ - public abstract class TagletWriter { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ValueTaglet.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ValueTaglet.java index f19cbeeccd7..ab946511728 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ValueTaglet.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ValueTaglet.java @@ -46,7 +46,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils; * is retrieved for the field that the inline tag appears on. The name is specified * in the following format: [fully qualified class name]#[constant field name]. */ - public class ValueTaglet extends BaseTaglet { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/package-info.java index cb2b40de06b..9b01b5e86a3 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/package-info.java @@ -24,23 +24,23 @@ */ /** - * This package has classes used to generate output for Javadoc tags. + * This package has classes used to generate output for Javadoc tags. * - *

Doclets no longer have to implement their own version of standard tags - * such as @param and @throws. Individual taglets provide - * common processing, independent of the output format. - * Each doclet must have a taglet writer that takes a taglet - * as input and writes doclet-dependent output. The taglet itself will - * do the tag processing. For example, suppose we are outputting - * @throws tags. The taglet would: - *

- * After doing the steps above, the taglet would pass the information to - * the taglet writer for writing. The taglets are essentially builders for - * tags. + *

Doclets no longer have to implement their own version of standard tags + * such as @param and @throws. Individual taglets provide + * common processing, independent of the output format. + * Each doclet must have a taglet writer that takes a taglet + * as input and writes doclet-dependent output. The taglet itself will + * do the tag processing. For example, suppose we are outputting + * @throws tags. The taglet would: + *

+ * After doing the steps above, the taglet would pass the information to + * the taglet writer for writing. The taglets are essentially builders for + * tags. */ package jdk.javadoc.internal.doclets.toolkit.taglets; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java index 70eb4f08def..4f669550617 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassTree.java @@ -275,7 +275,7 @@ public class ClassTree { } /** - * Return the sub-class set for the class passed. + * Return the sub-class set for the class passed. * * @param typeElement class whose sub-class set is required. */ @@ -284,7 +284,7 @@ public class ClassTree { } /** - * Return the sub-interface set for the interface passed. + * Return the sub-interface set for the interface passed. * * @param typeElement interface whose sub-interface set is required. */ @@ -293,7 +293,7 @@ public class ClassTree { } /** - * Return the set of classes which implement the interface passed. + * Return the set of classes which implement the interface passed. * * @param typeElement interface whose implementing-classes set is required. */ @@ -318,7 +318,7 @@ public class ClassTree { } /** - * Return the sub-class/interface set for the class/interface passed. + * Return the sub-class/interface set for the class/interface passed. * * @param typeElement class/interface whose sub-class/interface set is required. * @param isEnum true if the subClasses should be forced to come from the @@ -369,16 +369,16 @@ public class ClassTree { } /** - * Return a set of base classes. This will have only one element namely - * the TypeElement for java.lang.Object, since this is the base class for all - * classes. + * Return a set of base classes. This will have only one element namely + * the TypeElement for java.lang.Object, since this is the base class for all + * classes. */ public SortedSet baseClasses() { return baseClasses; } /** - * Return the set of base interfaces. This is the set of interfaces + * Return the set of base interfaces. This is the set of interfaces * which do not have super-interface. */ public SortedSet baseInterfaces() { @@ -386,8 +386,8 @@ public class ClassTree { } /** - * Return the set of base enums. This is the set of enums - * which do not have super-enums. + * Return the set of base enums. This is the set of enums + * which do not have super-enums. */ public SortedSet baseEnums() { return baseEnums; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/CommentHelper.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/CommentHelper.java index 1d69639582e..d3a0c6090e0 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/CommentHelper.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/CommentHelper.java @@ -75,7 +75,7 @@ import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration; import static com.sun.source.doctree.DocTree.Kind.*; /** - * A utility class. + * A utility class. */ public class CommentHelper { private final BaseConfiguration configuration; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Comparators.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Comparators.java index bbc58ebb838..02f16009391 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Comparators.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Comparators.java @@ -42,7 +42,7 @@ import java.util.Comparator; import java.util.List; /** - * A collection of {@code Comparator} factory methods. + * A collection of {@code Comparator} factory methods. */ public class Comparators { @@ -212,17 +212,17 @@ public class Comparators { private Comparator indexUseComparator = null; /** - * Returns an {@code Element} Comparator for index file presentations, and are sorted as follows. - * If comparing modules and/or packages then simply compare the qualified names, - * if comparing a module or a package with a type/member then compare the - * FullyQualifiedName of the module or a package with the SimpleName of the entity, - * otherwise: - * 1. compare the ElementKind ex: Module, Package, Interface etc. - * 2a. if equal and if the type is of ExecutableElement(Constructor, Methods), - * a case insensitive comparison of parameter the type signatures - * 2b. if equal, case sensitive comparison of the type signatures - * 3. if equal, compare the FQNs of the entities - * 4. finally, if equal, compare the names of the enclosing modules + * Returns an {@code Element} Comparator for index file presentations, and are sorted as follows. + * If comparing modules and/or packages then simply compare the qualified names, + * if comparing a module or a package with a type/member then compare the + * FullyQualifiedName of the module or a package with the SimpleName of the entity, + * otherwise: + * 1. compare the ElementKind ex: Module, Package, Interface etc. + * 2a. if equal and if the type is of ExecutableElement(Constructor, Methods), + * a case insensitive comparison of parameter the type signatures + * 2b. if equal, case sensitive comparison of the type signatures + * 3. if equal, compare the FQNs of the entities + * 4. finally, if equal, compare the names of the enclosing modules * @return an element comparator for index file use */ public Comparator makeIndexElementComparator() { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java index 986e8863e51..b12e0c9debe 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java @@ -40,11 +40,11 @@ import jdk.javadoc.internal.doclets.toolkit.Messages; import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*; /** - * An alphabetical index of elements, search tags, and other items. - * Two tables are maintained: - * one is indexed by the first character of each items name; - * the other is index by the item's category, indicating the JavaScript - * file in which the item should be written. + * An alphabetical index of elements, search tags, and other items. + * Two tables are maintained: + * one is indexed by the first character of each items name; + * the other is index by the item's category, indicating the JavaScript + * file in which the item should be written. */ public class IndexBuilder { 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 b40c38626ee..d21bd569122 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 @@ -34,7 +34,6 @@ import java.util.Map; /** * This class manages the visible member table for each type element. */ - public class VisibleMemberCache { private final Map cache; private final BaseConfiguration configuration; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java index 9ab7f163f1e..4043ca57a1b 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java @@ -89,7 +89,6 @@ import jdk.javadoc.internal.doclets.toolkit.PropertyUtils; * type, as its own view, and will present some form of this to the * doclet as and when required to. */ - public class VisibleMemberTable { public enum Kind { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/LinkInfo.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/LinkInfo.java index 7974066f618..aacdbcaa9e2 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/LinkInfo.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/LinkInfo.java @@ -35,7 +35,7 @@ import jdk.javadoc.internal.doclets.toolkit.Content; import jdk.javadoc.internal.doclets.toolkit.util.Utils; /** - * Encapsulates information about a link. + * Encapsulates information about a link. */ public abstract class LinkInfo { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/package-info.java index 3ed53ccd8b6..0da22cd8dea 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/links/package-info.java @@ -24,6 +24,6 @@ */ /** - * Provides a factory for constructing links. + * Provides a factory for constructing links. */ package jdk.javadoc.internal.doclets.toolkit.util.links; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/package-info.java index f5b2b113154..ac280ddef5c 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/package-info.java @@ -24,7 +24,7 @@ */ /** - * This package has utility classes that perform common services required - * for API documentation generation. + * This package has utility classes that perform common services required + * for API documentation generation. */ package jdk.javadoc.internal.doclets.toolkit.util; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/package-info.java index 4d7da0ba7cd..1eb7f736a0a 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/package-info.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2022, 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 @@ -24,16 +24,16 @@ */ /** - * The implementation of the javadoc tool and associated doclets. + * The implementation of the javadoc tool and associated doclets. * - *

Internally, javadoc is composed of two primary parts: - * the {@link jdk.javadoc.internal.tool tool}, and a series of - * {@link jdk.javadoc.internal.doclets doclets}. + *

Internally, javadoc is composed of two primary parts: + * the {@link jdk.javadoc.internal.tool tool}, and a series of + * {@link jdk.javadoc.internal.doclets doclets}. * - *

The tool provides a common infrastructure for command-line processing, - * and for reading the declarations and documentation comments in Java source files, - * while doclets provide a user-selectable backend for determining - * how to process the declarations and their documentation comments. + *

The tool provides a common infrastructure for command-line processing, + * and for reading the declarations and documentation comments in Java source files, + * while doclets provide a user-selectable backend for determining + * how to process the declarations and their documentation comments. * *

The following provides a top-down description of the overall javadoc * software stack. diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/AccessKind.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/AccessKind.java index 0bc94981a8e..2e07a421acb 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/AccessKind.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/AccessKind.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2016, 2022, 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,7 +28,6 @@ package jdk.javadoc.internal.tool; /** * The access value kinds. */ - public enum AccessKind { /** Limits access to public entities */ PUBLIC, diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocEnter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocEnter.java index c335750d2a2..cec639df126 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocEnter.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocEnter.java @@ -39,8 +39,8 @@ import static com.sun.tools.javac.code.Kinds.Kind.*; import com.sun.tools.javac.main.JavaCompiler; /** - * Javadoc's own enter phase does a few things above and beyond that - * done by javac. + * Javadoc's own enter phase does a few things above and beyond that + * done by javac. */ public class JavadocEnter extends Enter { public static JavadocEnter instance(Context context) { 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 8ef15616747..51f45627f31 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 @@ -39,8 +39,8 @@ import static com.sun.tools.javac.code.Flags.*; import static com.sun.tools.javac.code.Kinds.Kind.*; /** - * Javadoc's own memberEnter phase does a few things above and beyond that - * done by javac. + * Javadoc's own memberEnter phase does a few things above and beyond that + * done by javac. */ public class JavadocMemberEnter extends MemberEnter { public static JavadocMemberEnter instance0(Context context) { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTodo.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTodo.java index 9528de29e2f..dba7eef32b0 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTodo.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTodo.java @@ -30,8 +30,8 @@ import com.sun.tools.javac.util.*; import com.sun.tools.javac.util.Context.Factory; /** - * Javadoc's own todo queue doesn't queue its inputs, as javadoc - * doesn't perform attribution of method bodies or semantic checking. + * Javadoc's own todo queue doesn't queue its inputs, as javadoc + * doesn't perform attribution of method bodies or semantic checking. */ public class JavadocTodo extends Todo { public static void preRegister(Context context) { diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTool.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTool.java index 160eeef531b..2f71422a7d6 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTool.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/JavadocTool.java @@ -57,10 +57,10 @@ import jdk.javadoc.doclet.DocletEnvironment; import static jdk.javadoc.internal.tool.Main.Result.*; /** - * This class could be the main entry point for Javadoc when Javadoc is used as a - * component in a larger software system. It provides operations to - * construct a new javadoc processor, and to run it on a set of source - * files. + * This class could be the main entry point for Javadoc when Javadoc is used as a + * component in a larger software system. It provides operations to + * construct a new javadoc processor, and to run it on a set of source + * files. */ public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler { ToolEnvironment toolEnv; @@ -93,7 +93,7 @@ public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler { } /** - * Construct a new javadoc tool. + * Construct a new javadoc tool. */ public static JavadocTool make0(Context context) { JavadocLog log = null; diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/Main.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/Main.java index 11a0de82634..ea2c7b3f7ab 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/Main.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/Main.java @@ -34,7 +34,6 @@ import com.sun.tools.javac.util.Context; /** * Provides external entry points (tool and programmatic) for the javadoc program. */ - public class Main { /** diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/package-info.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/package-info.java index e37207f4334..ead80301268 100644 --- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/package-info.java +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/package-info.java @@ -24,21 +24,21 @@ */ /** - * Provides the front end for the javadoc tool. + * Provides the front end for the javadoc tool. * - *

The main entry points are in {@link jdk.javadoc.internal.tool.Main} - * which calls the (poorly-named) {@link jdk.javadoc.internal.tool.Start} - * which provides the overall functionality of the tool. + *

The main entry points are in {@link jdk.javadoc.internal.tool.Main} + * which calls the (poorly-named) {@link jdk.javadoc.internal.tool.Start} + * which provides the overall functionality of the tool. * - *

The classes provide a framework for processing command-line options - * and determining the set of elements (modules, packages, types and members) - * to be documented. + *

The classes provide a framework for processing command-line options + * and determining the set of elements (modules, packages, types and members) + * to be documented. * - *

The classes also provide the means to use the javac front end to read - * source files, including the documentation comments. + *

The classes also provide the means to use the javac front end to read + * source files, including the documentation comments. * - *

Finally, once the appropriate files have been read, the classes invoke - * the selected doclet to process those files, typically to generate API - * documentation. + *

Finally, once the appropriate files have been read, the classes invoke + * the selected doclet to process those files, typically to generate API + * documentation. */ package jdk.javadoc.internal.tool;