8284387: Fix formatting of doc comments in jdk.javadoc
Reviewed-by: jjg
This commit is contained in:
Pavel Rappo
parent
4451257b14
commit
5a21397f70
@ -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</a>
|
||||
* @since 9
|
||||
*/
|
||||
|
||||
public interface Taglet {
|
||||
|
||||
/**
|
||||
|
||||
@ -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;
|
||||
|
||||
@ -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
|
||||
|
||||
@ -23,7 +23,6 @@
|
||||
* questions.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* The set of low-level file-formats, to be used in conjunction with
|
||||
* the {@link jdk.javadoc.internal.doclets.toolkit doclets.toolkit} API.
|
||||
|
||||
@ -38,6 +38,5 @@
|
||||
* {@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;
|
||||
|
||||
@ -30,7 +30,6 @@ import javax.lang.model.element.Element;
|
||||
/**
|
||||
* The interface for writing annotation type required member output.
|
||||
*/
|
||||
|
||||
public interface AnnotationTypeMemberWriter extends MemberWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -32,7 +32,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
/**
|
||||
* The interface for writing class output.
|
||||
*/
|
||||
|
||||
public interface ClassWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
/**
|
||||
* The interface for writing constants summary output.
|
||||
*/
|
||||
|
||||
public interface ConstantsSummaryWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -30,7 +30,6 @@ import javax.lang.model.element.ExecutableElement;
|
||||
/**
|
||||
* The interface for writing constructor output.
|
||||
*/
|
||||
|
||||
public interface ConstructorWriter extends MemberWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -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<DocPath> getStylesheets() throws DocletException;
|
||||
|
||||
@ -31,7 +31,6 @@ import javax.lang.model.element.VariableElement;
|
||||
/**
|
||||
* The interface for writing enum constant output.
|
||||
*/
|
||||
|
||||
public interface EnumConstantWriter extends MemberWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -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 {
|
||||
|
||||
/**
|
||||
|
||||
@ -35,7 +35,6 @@ import com.sun.source.doctree.DocTree;
|
||||
/**
|
||||
* The interface for writing member summary output.
|
||||
*/
|
||||
|
||||
public interface MemberSummaryWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -31,7 +31,6 @@ import javax.lang.model.type.TypeMirror;
|
||||
/**
|
||||
* The interface for writing method output.
|
||||
*/
|
||||
|
||||
public interface MethodWriter extends MemberWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -30,7 +30,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
/**
|
||||
* The interface for writing module summary output.
|
||||
*/
|
||||
|
||||
public interface ModuleSummaryWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -28,6 +28,5 @@ package jdk.javadoc.internal.doclets.toolkit;
|
||||
/**
|
||||
* The interface for writing class output.
|
||||
*/
|
||||
|
||||
public interface NestedClassWriter {
|
||||
}
|
||||
|
||||
@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
/**
|
||||
* The interface for writing package summary output.
|
||||
*/
|
||||
|
||||
public interface PackageSummaryWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -30,7 +30,6 @@ import javax.lang.model.element.ExecutableElement;
|
||||
/**
|
||||
* The interface for writing property output.
|
||||
*/
|
||||
|
||||
public interface PropertyWriter extends MemberWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -37,7 +37,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
/**
|
||||
* The interface for writing serialized form output.
|
||||
*/
|
||||
|
||||
public interface SerializedFormWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -36,7 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
|
||||
/**
|
||||
* The interface for a factory creates writers.
|
||||
*/
|
||||
|
||||
public interface WriterFactory {
|
||||
|
||||
/**
|
||||
|
||||
@ -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 {
|
||||
/**
|
||||
|
||||
@ -41,7 +41,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
|
||||
/**
|
||||
* The factory for constructing builders.
|
||||
*/
|
||||
|
||||
public class BuilderFactory {
|
||||
|
||||
/**
|
||||
|
||||
@ -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;
|
||||
|
||||
@ -45,7 +45,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content;
|
||||
* displays as:
|
||||
* <blockquote> The type {@code List<P>} </blockquote>
|
||||
*/
|
||||
|
||||
public class CodeTaglet extends BaseTaglet {
|
||||
|
||||
CodeTaglet() {
|
||||
|
||||
@ -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() {
|
||||
|
||||
@ -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 {
|
||||
|
||||
/**
|
||||
|
||||
@ -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() {
|
||||
|
||||
@ -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 {
|
||||
|
||||
/**
|
||||
|
||||
@ -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:
|
||||
* <blockquote> {@literal a<B>c} </blockquote>
|
||||
*/
|
||||
|
||||
public class LiteralTaglet extends BaseTaglet {
|
||||
|
||||
LiteralTaglet() {
|
||||
|
||||
@ -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 {
|
||||
|
||||
/**
|
||||
|
||||
@ -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() {
|
||||
|
||||
@ -36,7 +36,6 @@ import java.util.EnumSet;
|
||||
/**
|
||||
* A taglet that represents the {@code @systemProperty} tag.
|
||||
*/
|
||||
|
||||
public class SystemPropertyTaglet extends BaseTaglet {
|
||||
|
||||
SystemPropertyTaglet(){
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -83,7 +83,6 @@ import static javax.tools.DocumentationTool.Location.TAGLET_PATH;
|
||||
/**
|
||||
* Manages the {@code Taglet}s used by doclets.
|
||||
*/
|
||||
|
||||
public class TagletManager {
|
||||
|
||||
/**
|
||||
|
||||
@ -53,7 +53,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
/**
|
||||
* The interface for the taglet writer.
|
||||
*/
|
||||
|
||||
public abstract class TagletWriter {
|
||||
|
||||
/**
|
||||
|
||||
@ -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 {
|
||||
|
||||
/**
|
||||
|
||||
@ -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<TypeElement, VisibleMemberTable> cache;
|
||||
private final BaseConfiguration configuration;
|
||||
|
||||
@ -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 {
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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,
|
||||
|
||||
@ -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 {
|
||||
|
||||
/**
|
||||
|
||||
Loading…
Reference in New Issue
Block a user