8284362: Remove the "unsupported API" warning from jdk.javadoc
Reviewed-by: jjg
This commit is contained in:
parent
ff1daa85b0
commit
20acea41cc
@ -43,11 +43,6 @@ import jdk.javadoc.internal.tool.Start;
|
||||
/**
|
||||
* Provides access to functionality specific to the JDK documentation tool,
|
||||
* javadoc.
|
||||
*
|
||||
* <p><b>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.</b></p>
|
||||
*/
|
||||
public class JavadocTaskImpl implements DocumentationTask {
|
||||
private final AtomicBoolean used = new AtomicBoolean();
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2012, 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
|
||||
@ -55,11 +55,6 @@ import jdk.javadoc.internal.tool.ToolOptions;
|
||||
/**
|
||||
* Provides access to functionality specific to the JDK documentation tool,
|
||||
* javadoc.
|
||||
*
|
||||
* <p><b>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.</b></p>
|
||||
*/
|
||||
public class JavadocTool implements DocumentationTool {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2003, 2018, 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
|
||||
@ -27,10 +27,5 @@
|
||||
* 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.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
package jdk.javadoc.internal.api;
|
||||
|
@ -54,11 +54,6 @@ import static jdk.javadoc.internal.doclets.formats.html.HtmlLinkInfo.Kind.THROWS
|
||||
|
||||
/**
|
||||
* Print method and constructor info.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class AbstractExecutableMemberWriter extends AbstractMemberWriter {
|
||||
|
||||
|
@ -51,11 +51,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
|
||||
/**
|
||||
* The base class for member writers.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class AbstractMemberWriter implements MemberSummaryWriter, MemberWriter {
|
||||
|
||||
|
@ -37,12 +37,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
|
||||
|
||||
/**
|
||||
* Abstract class to generate the overview files.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
*/
|
||||
public abstract class AbstractOverviewIndexWriter extends HtmlDocletWriter {
|
||||
|
||||
|
@ -42,11 +42,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
|
||||
* is sub-classed by {@link PackageTreeWriter} and {@link TreeWriter} to
|
||||
* generate the Package Tree and global Tree(for all the classes and packages)
|
||||
* pages.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class AbstractTreeWriter extends HtmlDocletWriter {
|
||||
|
||||
|
@ -44,11 +44,6 @@ import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
|
||||
|
||||
/**
|
||||
* Writes annotation interface member documentation in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class AnnotationTypeMemberWriterImpl extends AbstractMemberWriter
|
||||
implements AnnotationTypeMemberWriter, MemberSummaryWriter {
|
||||
|
@ -54,11 +54,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
|
||||
/**
|
||||
* Generate class usage information.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ClassUseWriter extends SubWriterHolderWriter {
|
||||
|
||||
|
@ -61,11 +61,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
|
||||
/**
|
||||
* Generate the Class Information Page.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see javax.lang.model.element.TypeElement
|
||||
*/
|
||||
public class ClassWriterImpl extends SubWriterHolderWriter implements ClassWriter {
|
||||
|
@ -52,11 +52,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.IndexItem;
|
||||
|
||||
/**
|
||||
* Write the Constants Summary Page in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ConstantsSummaryWriterImpl extends HtmlDocletWriter implements ConstantsSummaryWriter {
|
||||
|
||||
|
@ -49,11 +49,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Writes constructor documentation.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ConstructorWriterImpl extends AbstractExecutableMemberWriter
|
||||
implements ConstructorWriter, MemberSummaryWriter {
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 1997, 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
|
||||
@ -43,11 +43,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
/**
|
||||
* Generate File to list all the deprecated classes and class members with the
|
||||
* appropriate links.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class DeprecatedListWriter extends SummaryListWriter<DeprecatedAPIListBuilder> {
|
||||
|
||||
|
@ -40,11 +40,6 @@ import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
|
||||
|
||||
/**
|
||||
* Writes enum constant documentation in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class EnumConstantWriterImpl extends AbstractMemberWriter
|
||||
implements EnumConstantWriter, MemberSummaryWriter {
|
||||
|
@ -43,11 +43,6 @@ import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
|
||||
|
||||
/**
|
||||
* Writes field documentation in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class FieldWriterImpl extends AbstractMemberWriter
|
||||
implements FieldWriter, MemberSummaryWriter {
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 1998, 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
|
||||
@ -29,11 +29,6 @@ import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
|
||||
|
||||
/**
|
||||
* Aliases for HTML heading tags (H1..H6) for different kinds of pages.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
class Headings {
|
||||
/**
|
||||
|
@ -46,11 +46,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
/**
|
||||
* Generate the Help File for the generated API documentation. The help file
|
||||
* contents are helpful for browsing the generated documentation.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HelpWriter extends HtmlDocletWriter {
|
||||
|
||||
|
@ -76,11 +76,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.PreviewAPIListBuilder;
|
||||
* Also do the error checking on the options used. For example it is illegal to
|
||||
* use "-helpfile" option when already "-nohelp" option is used.
|
||||
* </p>
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlConfiguration extends BaseConfiguration {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 1997, 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
|
||||
@ -58,11 +58,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.PreviewAPIListBuilder;
|
||||
|
||||
/**
|
||||
* The class with "start" method, calls individual Writers.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlDoclet extends AbstractDoclet {
|
||||
|
||||
|
@ -125,11 +125,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.CommentHelper.SPACER;
|
||||
* Class for the Html Format Code Generation specific to JavaDoc.
|
||||
* This Class contains methods related to the Html Code Generation which
|
||||
* are used extensively while generating the entire documentation.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlDocletWriter {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 1998, 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
|
||||
@ -50,11 +50,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
* in index items: {@code containingModule}, {@code containingPackage},
|
||||
* {@code containingClass}, and {@code url}, and to write out the
|
||||
* JavaScript files.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlIndexBuilder extends IndexBuilder {
|
||||
private final HtmlConfiguration configuration;
|
||||
|
@ -51,11 +51,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.links.LinkInfo;
|
||||
|
||||
/**
|
||||
* A factory that returns a link given the information about it.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlLinkFactory extends LinkFactory {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2003, 2021, 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
|
||||
@ -39,10 +39,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.links.LinkInfo;
|
||||
|
||||
|
||||
/**
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlLinkInfo extends LinkInfo {
|
||||
|
||||
|
@ -47,11 +47,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper;
|
||||
* Generate serialized form for serializable fields.
|
||||
* Documentation denoted by the tags <code>serial</code> and
|
||||
* <code>serialField</code> is processed.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlSerialFieldWriter extends FieldWriterImpl
|
||||
implements SerializedFormWriter.SerialFieldWriter {
|
||||
|
@ -40,11 +40,6 @@ import jdk.javadoc.internal.doclets.toolkit.taglets.TagletManager;
|
||||
/**
|
||||
* Generate serialized form for Serializable/Externalizable methods.
|
||||
* Documentation denoted by the <code>serialData</code> tag is processed.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlSerialMethodWriter extends MethodWriterImpl implements
|
||||
SerializedFormWriter.SerialMethodWriter {
|
||||
|
@ -59,11 +59,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.IndexItem;
|
||||
* documented elements, terms defined in some documentation comments,
|
||||
* and summary pages.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see IndexBuilder
|
||||
*/
|
||||
public class IndexWriter extends HtmlDocletWriter {
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -29,11 +29,6 @@ import jdk.javadoc.internal.doclets.formats.html.markup.Comment;
|
||||
|
||||
/**
|
||||
* Marker comments to identify regions in the generated files.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class MarkerComments {
|
||||
|
||||
|
@ -47,11 +47,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
|
||||
|
||||
/**
|
||||
* Writes method documentation in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class MethodWriterImpl extends AbstractExecutableMemberWriter
|
||||
implements MethodWriter, MemberSummaryWriter {
|
||||
|
@ -41,11 +41,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
|
||||
/**
|
||||
* Generate the module index page "index.html".
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ModuleIndexWriter extends AbstractOverviewIndexWriter {
|
||||
|
||||
|
@ -59,11 +59,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
* Class to generate file for each module contents in the right-hand frame. This will list all the
|
||||
* required modules, packages and service types for the module. A click on any of the links will update
|
||||
* the frame with the clicked element page.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryWriter {
|
||||
|
||||
|
@ -41,11 +41,6 @@ import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
|
||||
|
||||
/**
|
||||
* Writes nested class documentation in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class NestedClassWriterImpl extends AbstractMemberWriter
|
||||
implements MemberSummaryWriter {
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2021, 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
|
||||
@ -46,12 +46,6 @@ import static com.sun.source.doctree.DocTree.Kind.SINCE;
|
||||
|
||||
/**
|
||||
* Generates a file containing a list of new API elements with the appropriate links.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
*/
|
||||
public class NewAPIListWriter extends SummaryListWriter<NewAPIBuilder> {
|
||||
|
||||
|
@ -40,11 +40,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Group;
|
||||
|
||||
/**
|
||||
* Generate the package index page "index.html".
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class PackageIndexWriter extends AbstractOverviewIndexWriter {
|
||||
|
||||
|
@ -44,11 +44,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
/**
|
||||
* Class to generate Tree page for a package. The name of the file generated is
|
||||
* "package-tree.html" and it is generated in the respective package directory.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class PackageTreeWriter extends AbstractTreeWriter {
|
||||
|
||||
|
@ -49,11 +49,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
|
||||
/**
|
||||
* Generate package usage information.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class PackageUseWriter extends SubWriterHolderWriter {
|
||||
|
||||
|
@ -59,11 +59,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
* Class to generate file for each package contents in the right-hand
|
||||
* frame. This will list all the Class Kinds in the package. A click on any
|
||||
* class-kind will update the frame with the clicked class-kind page.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class PackageWriterImpl extends HtmlDocletWriter
|
||||
implements PackageSummaryWriter {
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 1997, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 1997, 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
|
||||
@ -43,11 +43,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.PreviewAPIListBuilder;
|
||||
* Generate File to list all the preview elements with the
|
||||
* appropriate links.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see java.util.List
|
||||
*/
|
||||
public class PreviewListWriter extends SummaryListWriter<PreviewAPIListBuilder> {
|
||||
|
@ -40,11 +40,6 @@ import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
|
||||
|
||||
/**
|
||||
* Writes property documentation in HTML format.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class PropertyWriterImpl extends AbstractMemberWriter
|
||||
implements PropertyWriter, MemberSummaryWriter {
|
||||
|
@ -44,11 +44,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.IndexItem;
|
||||
|
||||
/**
|
||||
* Generates the Serialized Form Information Page, <i>serialized-form.html</i>.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class SerializedFormWriterImpl extends SubWriterHolderWriter
|
||||
implements SerializedFormWriter {
|
||||
|
@ -56,11 +56,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
|
||||
/**
|
||||
* Converts Java Source Code to HTML.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class SourceToHTMLConverter {
|
||||
|
||||
|
@ -48,11 +48,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
|
||||
* can not be used effectively to change formatting. The concrete
|
||||
* class subclass of this class can be subclassed to change formatting.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see AbstractMemberWriter
|
||||
* @see ClassWriterImpl
|
||||
*/
|
||||
|
@ -47,11 +47,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.SummaryAPIListBuilder.SummaryEl
|
||||
/**
|
||||
* Base class for generating a summary page that lists elements with a common characteristic,
|
||||
* such as deprecated elements, preview elements, and so on.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class SummaryListWriter<L extends SummaryAPIListBuilder> extends SubWriterHolderWriter {
|
||||
|
||||
|
@ -52,11 +52,6 @@ import java.util.ArrayList;
|
||||
|
||||
/**
|
||||
* Generates the file with the summary of all the system properties.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class SystemPropertiesWriter extends HtmlDocletWriter {
|
||||
|
||||
|
@ -67,11 +67,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content;
|
||||
* one of a list of tabs above the table. If the table does not support filtered
|
||||
* views, the caption element is typically displayed as a single (inactive)
|
||||
* tab.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class Table extends Content {
|
||||
private final HtmlStyle tableStyle;
|
||||
|
@ -42,11 +42,6 @@ import jdk.javadoc.internal.doclets.toolkit.Content;
|
||||
* The header contains a list of {@code <th>} cells, providing the column headers.
|
||||
* The attribute {@code scope="col"} is automatically added to each header cell.
|
||||
* In addition, a series of style class names can be specified, to be applied one per cell.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class TableHeader extends Content {
|
||||
|
||||
|
@ -80,11 +80,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils.PreviewFlagProvider;
|
||||
|
||||
/**
|
||||
* The taglet writer that writes HTML.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public class TagletWriterImpl extends TagletWriter {
|
||||
|
@ -45,11 +45,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
* ClassTree for building the Tree. The name of
|
||||
* the generated file is "overview-tree.html" and it is generated in the
|
||||
* current or the destination directory.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class TreeWriter extends AbstractTreeWriter {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2003, 2021, 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
|
||||
@ -44,11 +44,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
|
||||
|
||||
/**
|
||||
* The factory that returns HTML writers.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class WriterFactoryImpl implements WriterFactory {
|
||||
|
||||
|
@ -39,11 +39,6 @@ import java.util.Objects;
|
||||
* The content is a {@code <div>} element that contains a
|
||||
* header that is always visible, and main content that
|
||||
* can be scrolled if necessary.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class BodyContents extends Content {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -34,11 +34,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
|
||||
/**
|
||||
* Class for generating a comment for HTML pages of javadoc output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class Comment extends Content {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -27,11 +27,6 @@ package jdk.javadoc.internal.doclets.formats.html.markup;
|
||||
|
||||
/**
|
||||
* Supported DOCTYPE declarations.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public enum DocType {
|
||||
HTML5("<!DOCTYPE HTML>");
|
||||
|
@ -43,11 +43,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
|
||||
* An HTML {@code <head>} element.
|
||||
*
|
||||
* Many methods return the current object, to facilitate fluent builder-style usage.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class Head extends Content {
|
||||
private final Runtime.Version docletVersion;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -29,11 +29,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
|
||||
/**
|
||||
* Enum representing HTML tag attributes.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public enum HtmlAttr {
|
||||
ALT,
|
||||
|
@ -37,11 +37,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
|
||||
/**
|
||||
* Class for generating an HTML document for javadoc output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class HtmlDocument {
|
||||
private final DocType docType = DocType.HTML5;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -31,11 +31,6 @@ import java.util.regex.Pattern;
|
||||
/**
|
||||
* Enum representing HTML styles, with associated entries in the stylesheet files.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @apiNote
|
||||
* Despite the name, the members of this enum provide values for the HTML {@code class} attribute,
|
||||
* and <strong>not</strong> the HTML {@code style} attribute.
|
||||
|
@ -59,11 +59,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
* attributes for the element. See:
|
||||
* <a href="https://en.wikipedia.org/wiki/HTML_element">HTML element</a>.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see <a href="https://html.spec.whatwg.org/multipage/syntax.html#normal-elements">WhatWG: Normal Elements</a>
|
||||
* @see <a href="https://www.w3.org/TR/html51/syntax.html#writing-html-documents-elements">HTML 5.1: Elements</a>
|
||||
*/
|
||||
|
@ -31,11 +31,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
|
||||
|
||||
/**
|
||||
* Factory for HTML A elements: links (with a {@code href} attribute).
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class Links {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -33,11 +33,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
|
||||
/**
|
||||
* Class for generating raw HTML content to be added to HTML pages of javadoc output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class RawHtml extends Content {
|
||||
|
||||
|
@ -33,11 +33,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
|
||||
/**
|
||||
* A builder for HTML script elements.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class Script {
|
||||
private final StringBuilder sb;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -30,11 +30,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
/**
|
||||
* Enum representing the names for HTML elements.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see <a href="https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-name">WhatWG: Tag Name</a>
|
||||
* @see <a href="https://www.w3.org/TR/html51/syntax.html#tag-name">HTML 5.1: Tag Name</a>
|
||||
*/
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -33,11 +33,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
|
||||
/**
|
||||
* Class for containing immutable string content for HTML tags of javadoc output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class Text extends Content {
|
||||
private final String string;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2010, 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
|
||||
@ -34,11 +34,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
|
||||
/**
|
||||
* Class for generating string content for HTML tags of javadoc output.
|
||||
* The content is mutable to the extent that additional content may be added.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class TextBuilder extends Content {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2007, 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
|
||||
@ -33,11 +33,6 @@
|
||||
* and {@link jdk.javadoc.internal.doclets.formats.html.Table Table}
|
||||
* to help build more complex HTML trees.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @see <a href="https://html.spec.whatwg.org/multipage/">HTML: Living Standard</a>
|
||||
* @see <a href="https://html.spec.whatwg.org/multipage/syntax,html">HTML: Living Standard: The HTML Syntax</a>
|
||||
* @see <a href="https://www.w3.org/TR/html51/">HTML 5.1</a>
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2018, 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
|
||||
@ -30,10 +30,5 @@
|
||||
*
|
||||
* <p>Currently, only {@link jdk.javadoc.internal.doclets.formats.html HTML}
|
||||
* format is supported.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
package jdk.javadoc.internal.doclets.formats;
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2003, 2019, 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
|
||||
@ -38,11 +38,6 @@
|
||||
* {@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}.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
package jdk.javadoc.internal.doclets;
|
||||
|
@ -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
|
||||
@ -53,11 +53,6 @@ import static javax.tools.Diagnostic.Kind.*;
|
||||
|
||||
/**
|
||||
* An abstract implementation of a Doclet.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class AbstractDoclet implements Doclet {
|
||||
|
||||
|
@ -29,11 +29,6 @@ import javax.lang.model.element.Element;
|
||||
|
||||
/**
|
||||
* The interface for writing annotation type required member output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface AnnotationTypeMemberWriter extends MemberWriter {
|
||||
|
@ -90,11 +90,6 @@ import jdk.javadoc.internal.doclint.DocLint;
|
||||
* Configure the output based on the options. Doclets should sub-class
|
||||
* BaseConfiguration, to configure and add their own options. This class contains
|
||||
* all user options which are supported by the standard doclet.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class BaseConfiguration {
|
||||
/**
|
||||
|
@ -31,11 +31,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
|
||||
/**
|
||||
* The interface for writing class output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface ClassWriter {
|
||||
|
@ -67,11 +67,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
|
||||
|
||||
/**
|
||||
* A utility class for handling documentation comments.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class CommentUtils {
|
||||
|
||||
|
@ -35,11 +35,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
|
||||
/**
|
||||
* The interface for writing constants summary output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface ConstantsSummaryWriter {
|
||||
|
@ -29,11 +29,6 @@ import javax.lang.model.element.ExecutableElement;
|
||||
|
||||
/**
|
||||
* The interface for writing constructor output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface ConstructorWriter extends MemberWriter {
|
||||
|
@ -33,11 +33,6 @@ import java.util.function.Function;
|
||||
|
||||
/**
|
||||
* A content tree for javadoc output pages.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class Content {
|
||||
|
||||
|
@ -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
|
||||
@ -35,11 +35,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
/**
|
||||
* This is a pseudo-element wrapper for doc-files html contents, essentially to
|
||||
* associate the doc-files' html documentation's {@code DocCommentTree} to an element.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class DocFileElement implements DocletElement {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2017, 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
|
||||
@ -31,11 +31,6 @@ import java.util.List;
|
||||
import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
|
||||
/**
|
||||
* The interface for copying doc-files to the output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface DocFilesHandler {
|
||||
|
@ -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
|
||||
@ -29,11 +29,6 @@ package jdk.javadoc.internal.doclets.toolkit;
|
||||
/**
|
||||
* Supertype for all checked doclet exceptions.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*
|
||||
* @apiNote This is primarily intended for the benefit of the builder API
|
||||
* in {@code jdk.javadoc.internal.doclets.toolkit.builders}.
|
||||
*/
|
||||
|
@ -30,11 +30,6 @@ import javax.lang.model.element.VariableElement;
|
||||
|
||||
/**
|
||||
* The interface for writing enum constant output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface EnumConstantWriter extends MemberWriter {
|
||||
|
@ -30,11 +30,6 @@ import javax.lang.model.element.VariableElement;
|
||||
|
||||
/**
|
||||
* The interface for writing field output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface FieldWriter extends MemberWriter {
|
||||
|
@ -34,11 +34,6 @@ import com.sun.source.doctree.DocTree;
|
||||
|
||||
/**
|
||||
* The interface for writing member summary output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface MemberSummaryWriter {
|
||||
|
@ -27,11 +27,6 @@ package jdk.javadoc.internal.doclets.toolkit;
|
||||
|
||||
/**
|
||||
* Common behavior for writing members of a type.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public interface MemberWriter {
|
||||
|
||||
|
@ -30,11 +30,6 @@ import javax.lang.model.type.TypeMirror;
|
||||
|
||||
/**
|
||||
* The interface for writing method output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface MethodWriter extends MemberWriter {
|
||||
|
@ -29,11 +29,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
|
||||
/**
|
||||
* The interface for writing module summary output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface ModuleSummaryWriter {
|
||||
|
@ -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
|
||||
@ -27,11 +27,6 @@ package jdk.javadoc.internal.doclets.toolkit;
|
||||
|
||||
/**
|
||||
* The interface for writing class output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface NestedClassWriter {
|
||||
|
@ -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
|
||||
@ -31,11 +31,6 @@ import javax.tools.FileObject;
|
||||
/**
|
||||
* This is a pseudo element wrapper for the overview element, essentially to
|
||||
* associate overview documentation's DocCommentTree to this element.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class OverviewElement implements DocletElement {
|
||||
|
||||
|
@ -35,11 +35,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
|
||||
/**
|
||||
* The interface for writing package summary output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface PackageSummaryWriter {
|
||||
|
@ -29,11 +29,6 @@ import javax.lang.model.element.ExecutableElement;
|
||||
|
||||
/**
|
||||
* The interface for writing property output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface PropertyWriter extends MemberWriter {
|
||||
|
@ -36,11 +36,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
|
||||
|
||||
/**
|
||||
* The interface for writing serialized form output.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface SerializedFormWriter {
|
||||
|
@ -76,12 +76,6 @@ import static javax.lang.model.element.ElementKind.*;
|
||||
* A quarantine class to isolate all the workarounds and bridges to
|
||||
* a locality. This class should eventually disappear once all the
|
||||
* standard APIs support the needed interfaces.
|
||||
*
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class WorkArounds {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2003, 2021, 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,11 +35,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
|
||||
|
||||
/**
|
||||
* The interface for a factory creates writers.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public interface WriterFactory {
|
||||
|
@ -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
|
||||
@ -46,11 +46,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
* {@link ConstantsSummaryBuilder} to build a constant summary, all it has to
|
||||
* do is implement the ConstantsSummaryWriter interface and pass it to the
|
||||
* builder using a WriterFactory.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public abstract class AbstractBuilder {
|
||||
|
@ -38,11 +38,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind;
|
||||
* The superclass for all member builders. Member builders are only executed
|
||||
* within Class Builders. They essentially build sub-components. For example,
|
||||
* method documentation is a sub-component of class documentation.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class AbstractMemberBuilder extends AbstractBuilder {
|
||||
|
||||
|
@ -39,11 +39,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Builds documentation for required annotation type members.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class AnnotationTypeMemberBuilder extends AbstractMemberBuilder {
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2003, 2021, 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
|
||||
@ -40,11 +40,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
|
||||
|
||||
/**
|
||||
* The factory for constructing builders.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
|
||||
public class BuilderFactory {
|
||||
|
@ -48,11 +48,6 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
|
||||
|
||||
/**
|
||||
* Builds the summary for a given class.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ClassBuilder extends AbstractBuilder {
|
||||
|
||||
|
@ -41,11 +41,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Builds the Constants Summary Page.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ConstantsSummaryBuilder extends AbstractBuilder {
|
||||
|
||||
|
@ -40,11 +40,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Builds documentation for a constructor.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class ConstructorBuilder extends AbstractMemberBuilder {
|
||||
|
||||
|
@ -40,11 +40,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Builds documentation for a enum constants.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class EnumConstantBuilder extends AbstractMemberBuilder {
|
||||
|
||||
|
@ -40,11 +40,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Builds documentation for a field.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class FieldBuilder extends AbstractMemberBuilder {
|
||||
|
||||
|
@ -60,11 +60,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
* There are two anonymous subtype variants of this builder, created
|
||||
* in the {@link #getInstance} methods. One is for general types;
|
||||
* the other is for annotation types.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public abstract class MemberSummaryBuilder extends AbstractMemberBuilder {
|
||||
|
||||
|
@ -42,11 +42,6 @@ import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.
|
||||
|
||||
/**
|
||||
* Builds documentation for a method.
|
||||
*
|
||||
* <p><b>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.</b>
|
||||
*/
|
||||
public class MethodBuilder extends AbstractMemberBuilder {
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user