8236077: Clean up the use of modifiers and semicolons

Reviewed-by: jjg
This commit is contained in:
Pavel Rappo 2019-12-17 21:50:17 +00:00
parent a1d396c6cb
commit bdaa9c6a1c
59 changed files with 316 additions and 338 deletions

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2015, 2019, 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
@ -153,7 +153,7 @@ public interface Doclet {
/**
* The kind of an option.
*/
public static enum Kind {
enum Kind {
/** an extended option, such as those prefixed with -X */
EXTENDED,
/** a standard option */

View file

@ -510,11 +510,11 @@ public abstract class AbstractMemberWriter implements MemberSummaryWriter {
private Content exceptions;
// Threshold for length of type parameters before switching from inline to block representation.
private final static int TYPE_PARAMS_MAX_INLINE_LENGTH = 50;
private static final int TYPE_PARAMS_MAX_INLINE_LENGTH = 50;
// Threshold for combined length of modifiers, type params and return type before breaking
// it up with a line break before the return type.
private final static int RETURN_TYPE_MAX_LINE_LENGTH = 50;
private static final int RETURN_TYPE_MAX_LINE_LENGTH = 50;
/**
* Create a new member signature builder.

View file

@ -304,7 +304,7 @@ public class DocFilesHandlerImpl implements DocFilesHandler {
/**
* Constructor to construct the HtmlDocletWriter object.
*
* @param configuration the configuruation of this doclet.
* @param configuration the configuration of this doclet.
* @param path the file to be generated.
* @param e the anchoring element.
*/

View file

@ -79,7 +79,7 @@ public class HtmlSerialFieldWriter extends FieldWriterImpl
/**
* Return the header for serializable fields content section.
*
* @param isLastContent true if the cotent being documented is the last content.
* @param isLastContent true if the content being documented is the last content.
* @return a content tree for the header
*/
public Content getFieldsContentHeader(boolean isLastContent) {
@ -92,7 +92,7 @@ public class HtmlSerialFieldWriter extends FieldWriterImpl
* Add serializable fields.
*
* @param heading the heading for the section
* @param serializableFieldsTree the tree to be added to the serializable fileds
* @param serializableFieldsTree the tree to be added to the serializable fields
* content tree
* @return a content tree for the serializable fields content
*/

View file

@ -69,7 +69,7 @@ public class HtmlSerialMethodWriter extends MethodWriterImpl implements
/**
* Return the header for serializable methods content section.
*
* @param isLastContent true if the cotent being documented is the last content.
* @param isLastContent true if the content being documented is the last content.
* @return a content tree for the header
*/
public Content getMethodsContentHeader(boolean isLastContent) {

View file

@ -44,9 +44,9 @@ import jdk.javadoc.internal.doclets.toolkit.util.DocPaths;
/**
* Writes a file that tries to redirect to an alternate page.
* The redirect uses JavaScript, if enabled, falling back on
* {@code <meta http-eqiv=refresh content="0,<uri>">}.
* {@code <meta http-equiv=refresh content="0,<uri>">}.
* If neither are supported/enabled in a browser, the page displays the
* standard "JavaScipt not enabled" message, and a link to the alternate page.
* standard "JavaScript not enabled" message, and a link to the alternate page.
*/
public class IndexRedirectWriter extends HtmlDocletWriter {

View file

@ -168,13 +168,13 @@ public class MethodWriterImpl extends AbstractExecutableMemberWriter
? utils.getSimpleName(holder)
: utils.getFullyQualifiedName(holder),
false);
Content codelLink = HtmlTree.CODE(link);
Content codeLink = HtmlTree.CODE(link);
Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
utils.isClass(holder)
? contents.descfrmClassLabel
: contents.descfrmInterfaceLabel);
descfrmLabel.add(Entity.NO_BREAK_SPACE);
descfrmLabel.add(codelLink);
descfrmLabel.add(codeLink);
methodDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
writer.addInlineComment(method, methodDocTree);
}
@ -328,7 +328,7 @@ public class MethodWriterImpl extends AbstractExecutableMemberWriter
dl.add(dt);
Content overriddenTypeLink =
writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
Content codeOverriddenTypeLink = HtmlTree.CODE(overriddenTypeLink);
Content methlink = writer.getLink(
new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
holder)
@ -338,7 +338,7 @@ public class MethodWriterImpl extends AbstractExecutableMemberWriter
dd.add(Entity.NO_BREAK_SPACE);
dd.add(writer.contents.inClass);
dd.add(Entity.NO_BREAK_SPACE);
dd.add(codeOverridenTypeLink);
dd.add(codeOverriddenTypeLink);
dl.add(dd);
}
}

View file

@ -281,7 +281,7 @@ public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryW
}
packages.put(pkg, e);
}
};
}
// Get all exported packages for the module, using the exports directive for the module.
for (ModuleElement.ExportsDirective directive : ElementFilter.exportsIn(mdle.getDirectives())) {

View file

@ -81,7 +81,7 @@ public class PackageTreeWriter extends AbstractTreeWriter {
* @param configuration the configuration for this run.
* @param pkg Package for which tree file is to be generated.
* @param noDeprecated If true, do not generate any information for
* deprecated classe or interfaces.
* deprecated classes or interfaces.
* @throws DocFileIOException if there is a problem generating the package tree page
*/
public static void generate(HtmlConfiguration configuration,

View file

@ -148,7 +148,7 @@ public class Head {
* @param timestamp true if timestamps should be be added.
* @return this object
*/
// For temporary backwards compatibiility, if this method is not called,
// For temporary backwards compatibility, if this method is not called,
// no 'Generated by javadoc' comment will be added.
public Head setTimestamp(boolean timestamp) {
showTimestamp = timestamp;

View file

@ -97,7 +97,7 @@ public enum HtmlTag {
/**
* Enum representing the type of HTML element.
*/
public static enum BlockType {
public enum BlockType {
BLOCK,
INLINE,
OTHER
@ -106,7 +106,7 @@ public enum HtmlTag {
/**
* Enum representing HTML end tag requirement.
*/
public static enum EndTag {
public enum EndTag {
END,
NOEND
}

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2019, 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,7 +24,7 @@
*/
/**
* Doclets provide the user-selectable backends for processing the
* Doclets provide the user-selectable back ends for processing the
* documentation comments in Java source code.
*
* <p>Doclets are implementations of the {@link jdk.javadoc.doclet Doclet API}.</p>

View file

@ -44,21 +44,21 @@ public interface AnnotationTypeFieldWriter {
*
* @return content tree for the member tree header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
/**
* Add the annotation type field details marker.
*
* @param memberDetails the content tree representing field details marker
*/
public void addAnnotationFieldDetailsMarker(Content memberDetails);
void addAnnotationFieldDetailsMarker(Content memberDetails);
/**
* Add the annotation type details tree header.
*
* @param typeElement the annotation type being documented
*/
public Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
/**
* Get the annotation type documentation tree header.
@ -67,7 +67,7 @@ public interface AnnotationTypeFieldWriter {
* @param annotationDetailsTree the content tree representing annotation type details
* @return content tree for the annotation type documentation header
*/
public Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree);
Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree);
/**
* Get the annotation type details tree.
@ -76,7 +76,7 @@ public interface AnnotationTypeFieldWriter {
* @param annotationDetailsTree the content tree representing annotation type details
* @return content tree for the annotation type details
*/
public Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree);
Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree);
/**
* Get the annotation type documentation.
@ -84,7 +84,7 @@ public interface AnnotationTypeFieldWriter {
* @param annotationDocTree the content tree representing annotation type documentation
* @return content tree for the annotation type documentation
*/
public Content getAnnotationDoc(Content annotationDocTree);
Content getAnnotationDoc(Content annotationDocTree);
/**
* Get the signature for the given member.
@ -92,7 +92,7 @@ public interface AnnotationTypeFieldWriter {
* @param member the member being documented
* @return content tree for the annotation type signature
*/
public Content getSignature(Element member);
Content getSignature(Element member);
/**
* Add the deprecated output for the given member.
@ -100,7 +100,7 @@ public interface AnnotationTypeFieldWriter {
* @param member the member being documented
* @param annotationDocTree content tree to which the deprecated information will be added
*/
public void addDeprecated(Element member, Content annotationDocTree);
void addDeprecated(Element member, Content annotationDocTree);
/**
* Add the comments for the given member.
@ -108,7 +108,7 @@ public interface AnnotationTypeFieldWriter {
* @param member the member being documented
* @param annotationDocTree the content tree to which the comments will be added
*/
public void addComments(Element member, Content annotationDocTree);
void addComments(Element member, Content annotationDocTree);
/**
* Add the tags for the given member.
@ -116,5 +116,5 @@ public interface AnnotationTypeFieldWriter {
* @param member the member being documented
* @param annotationDocTree the content tree to which the tags will be added
*/
public void addTags(Element member, Content annotationDocTree);
void addTags(Element member, Content annotationDocTree);
}

View file

@ -45,5 +45,5 @@ public interface AnnotationTypeOptionalMemberWriter extends
* @param member the member being documented
* @param annotationDocTree content tree to which the default value will be added
*/
public void addDefaultValueInfo(Element member, Content annotationDocTree);
void addDefaultValueInfo(Element member, Content annotationDocTree);
}

View file

@ -44,21 +44,21 @@ public interface AnnotationTypeRequiredMemberWriter {
*
* @return content tree for the member tree header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
/**
* Add the annotation type details marker.
*
* @param memberDetails the content tree representing details marker
*/
public void addAnnotationDetailsMarker(Content memberDetails);
void addAnnotationDetailsMarker(Content memberDetails);
/**
* Add the annotation type details tree header.
*
* @param typeElement the annotation type being documented
*/
public Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
Content getAnnotationDetailsTreeHeader(TypeElement typeElement);
/**
* Get the annotation type documentation tree header.
@ -67,8 +67,7 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param annotationDetailsTree the content tree representing annotation type details
* @return content tree for the annotation type documentation header
*/
public Content getAnnotationDocTreeHeader(Element member,
Content annotationDetailsTree);
Content getAnnotationDocTreeHeader(Element member, Content annotationDetailsTree);
/**
* Get the annotation type details tree.
@ -77,7 +76,7 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param annotationDetailsTree the content tree representing annotation type details
* @return content tree for the annotation type details
*/
public Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree);
Content getAnnotationDetails(Content annotationDetailsTreeHeader, Content annotationDetailsTree);
/**
* Get the annotation type documentation.
@ -85,7 +84,7 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param annotationDocTree the content tree representing annotation type documentation
* @return content tree for the annotation type documentation
*/
public Content getAnnotationDoc(Content annotationDocTree);
Content getAnnotationDoc(Content annotationDocTree);
/**
* Get the signature for the given member.
@ -93,7 +92,7 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param member the member being documented
* @return content tree for the annotation type signature
*/
public Content getSignature(Element member);
Content getSignature(Element member);
/**
* Add the deprecated output for the given member.
@ -101,7 +100,7 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param member the member being documented
* @param annotationDocTree content tree to which the deprecated information will be added
*/
public void addDeprecated(Element member, Content annotationDocTree);
void addDeprecated(Element member, Content annotationDocTree);
/**
* Add the comments for the given member.
@ -109,7 +108,7 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param member the member being documented
* @param annotationDocTree the content tree to which the comments will be added
*/
public void addComments(Element member, Content annotationDocTree);
void addComments(Element member, Content annotationDocTree);
/**
* Add the tags for the given member.
@ -117,5 +116,5 @@ public interface AnnotationTypeRequiredMemberWriter {
* @param member the member being documented
* @param annotationDocTree the content tree to which the tags will be added
*/
public void addTags(Element member, Content annotationDocTree);
void addTags(Element member, Content annotationDocTree);
}

View file

@ -46,21 +46,21 @@ public interface AnnotationTypeWriter {
* @param header the header string to write
* @return a content tree for the header documentation
*/
public Content getHeader(String header);
Content getHeader(String header);
/**
* Get the annotation content header.
*
* @return annotation content header that needs to be added to the documentation
*/
public Content getAnnotationContentHeader();
Content getAnnotationContentHeader();
/**
* Get the annotation information tree header.
*
* @return annotation information tree header that needs to be added to the documentation
*/
public Content getAnnotationInfoTreeHeader();
Content getAnnotationInfoTreeHeader();
/**
* Get the annotation information.
@ -68,7 +68,7 @@ public interface AnnotationTypeWriter {
* @param annotationInfoTree content tree containing the annotation information
* @return a content tree for the annotation
*/
public Content getAnnotationInfo(Content annotationInfoTree);
Content getAnnotationInfo(Content annotationInfoTree);
/**
* Add the signature of the current annotation type.
@ -76,42 +76,42 @@ public interface AnnotationTypeWriter {
* @param modifiers the modifiers for the signature
* @param annotationInfoTree the annotation content tree to which the signature will be added
*/
public void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree);
void addAnnotationTypeSignature(String modifiers, Content annotationInfoTree);
/**
* Build the annotation type description.
*
* @param annotationInfoTree content tree to which the description will be added
*/
public void addAnnotationTypeDescription(Content annotationInfoTree);
void addAnnotationTypeDescription(Content annotationInfoTree);
/**
* Add the tag information for the current annotation type.
*
* @param annotationInfoTree content tree to which the tag information will be added
*/
public void addAnnotationTypeTagInfo(Content annotationInfoTree);
void addAnnotationTypeTagInfo(Content annotationInfoTree);
/**
* If this annotation is deprecated, add the appropriate information.
*
* @param annotationInfoTree content tree to which the deprecated information will be added
*/
public void addAnnotationTypeDeprecationInfo (Content annotationInfoTree);
void addAnnotationTypeDeprecationInfo(Content annotationInfoTree);
/**
* Get the member tree header for the annotation type.
*
* @return a content tree for the member tree header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
/**
* Add the annotation content tree to the documentation content tree.
*
* @param annotationContentTree annotation content tree which will be added to the content tree
*/
public void addAnnotationContentTree(Content annotationContentTree);
void addAnnotationContentTree(Content annotationContentTree);
/**
* Get the member tree.
@ -119,7 +119,7 @@ public interface AnnotationTypeWriter {
* @param memberTree the content tree that will be modified and returned
* @return a content tree for the member
*/
public Content getMemberTree(Content memberTree);
Content getMemberTree(Content memberTree);
/**
* Get the member summary tree.
@ -127,7 +127,7 @@ public interface AnnotationTypeWriter {
* @param memberTree the content tree that will be used to build the summary tree
* @return a content tree for the member summary
*/
public Content getMemberSummaryTree(Content memberTree);
Content getMemberSummaryTree(Content memberTree);
/**
* Get the member details tree.
@ -135,12 +135,12 @@ public interface AnnotationTypeWriter {
* @param memberTree the content tree that will be used to build the details tree
* @return a content tree for the member details
*/
public Content getMemberDetailsTree(Content memberTree);
Content getMemberDetailsTree(Content memberTree);
/**
* Add the footer of the page.
*/
public void addFooter();
void addFooter();
/**
* Print the document.
@ -148,12 +148,12 @@ public interface AnnotationTypeWriter {
* @param contentTree content tree that will be printed as a document
* @throws DocFileIOException if there is a problem while writing the document
*/
public void printDocument(Content contentTree) throws DocFileIOException;
void printDocument(Content contentTree) throws DocFileIOException;
/**
* Return the {@link TypeElement} being documented.
*
* @return the TypeElement representing the annotation being documented.
*/
public TypeElement getAnnotationTypeElement();
TypeElement getAnnotationTypeElement();
}

View file

@ -106,7 +106,7 @@ public abstract class BaseConfiguration {
public String tagletpath = null;
/**
* This is true if option "-serialwarn" is used. Defualt value is false to
* This is true if option "-serialwarn" is used. Default value is false to
* suppress excessive warnings about serial tag.
*/
public boolean serialwarn = false;
@ -243,8 +243,8 @@ public abstract class BaseConfiguration {
/**
* Don't generate deprecated API information at all, if -nodeprecated
* option is used. <code>nodepracted</code> is set to true if
* -nodeprecated option is used. Default is generate deprected API
* option is used. <code>nodeprecated</code> is set to true if
* -nodeprecated option is used. Default is generate deprecated API
* information.
*/
public boolean nodeprecated = false;
@ -1092,7 +1092,7 @@ public abstract class BaseConfiguration {
public abstract boolean showMessage(Element e, String key);
public static abstract class Option implements Doclet.Option, Comparable<Option> {
public abstract static class Option implements Doclet.Option, Comparable<Option> {
private final String[] names;
private final String parameters;
private final String description;
@ -1220,7 +1220,7 @@ public abstract class BaseConfiguration {
* collection.
*/
@SuppressWarnings("preview")
static private class Splitter {
private static class Splitter {
final Set<ModuleElement> mset = new LinkedHashSet<>();
final Set<PackageElement> pset = new LinkedHashSet<>();

View file

@ -46,63 +46,63 @@ public interface ClassWriter {
* @param header the header string to write
* @return header content that needs to be added to the documentation
*/
public Content getHeader(String header);
Content getHeader(String header);
/**
* Get the class content header.
*
* @return class content header that needs to be added to the documentation
*/
public Content getClassContentHeader();
Content getClassContentHeader();
/**
* Add the class tree documentation.
*
* @param classContentTree class content tree to which the documentation will be added
*/
public void addClassTree(Content classContentTree);
void addClassTree(Content classContentTree);
/**
* Get the class information tree header.
*
* @return class informaion tree header that needs to be added to the documentation
* @return class information tree header that needs to be added to the documentation
*/
public Content getClassInfoTreeHeader();
Content getClassInfoTreeHeader();
/**
* Add the type parameter and state component information.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addParamInfo(Content classInfoTree);
void addParamInfo(Content classInfoTree);
/**
* Add all super interfaces if this is an interface.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addSuperInterfacesInfo(Content classInfoTree);
void addSuperInterfacesInfo(Content classInfoTree);
/**
* Add all implemented interfaces if this is a class.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addImplementedInterfacesInfo(Content classInfoTree);
void addImplementedInterfacesInfo(Content classInfoTree);
/**
* Add all the classes that extend this one.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addSubClassInfo(Content classInfoTree);
void addSubClassInfo(Content classInfoTree);
/**
* Add all the interfaces that extend this one.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addSubInterfacesInfo(Content classInfoTree);
void addSubInterfacesInfo(Content classInfoTree);
/**
* If this is an interface, add all classes that implement this
@ -110,14 +110,14 @@ public interface ClassWriter {
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addInterfaceUsageInfo(Content classInfoTree);
void addInterfaceUsageInfo(Content classInfoTree);
/**
* If this is an functional interface, display appropriate message.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addFunctionalInterfaceInfo(Content classInfoTree);
void addFunctionalInterfaceInfo(Content classInfoTree);
/**
* If this is an inner class or interface, add the enclosing class or
@ -125,22 +125,22 @@ public interface ClassWriter {
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addNestedClassInfo (Content classInfoTree);
void addNestedClassInfo(Content classInfoTree);
/**
* Get the class information.
*
* @param classInfoTree content tree conatining the class information
* @param classInfoTree content tree containing the class information
* @return a content tree for the class
*/
public Content getClassInfo(Content classInfoTree);
Content getClassInfo(Content classInfoTree);
/**
* If this class is deprecated, add the appropriate information.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addClassDeprecationInfo (Content classInfoTree);
void addClassDeprecationInfo(Content classInfoTree);
/**
* Add the signature of the current class content tree.
@ -148,40 +148,40 @@ public interface ClassWriter {
* @param modifiers the modifiers for the signature
* @param classInfoTree the class content tree to which the signature will be added
*/
public void addClassSignature(String modifiers, Content classInfoTree);
void addClassSignature(String modifiers, Content classInfoTree);
/**
* Build the class description.
*
* @param classInfoTree content tree to which the documentation will be added
*/
public void addClassDescription(Content classInfoTree);
void addClassDescription(Content classInfoTree);
/**
* Add the tag information for the current class.
*
* @param classInfoTree content tree to which the tag information will be added
*/
public void addClassTagInfo(Content classInfoTree);
void addClassTagInfo(Content classInfoTree);
/**
* Get the member tree header for the class.
*
* @return a content tree for the member tree header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
/**
* Add the class content tree.
*
* @param classContentTree class content tree which will be added to the content tree
*/
public void addClassContentTree(Content classContentTree);
void addClassContentTree(Content classContentTree);
/**
* Add the footer of the page.
*/
public void addFooter();
void addFooter();
/**
* Print the document.
@ -189,14 +189,14 @@ public interface ClassWriter {
* @param contentTree content tree that will be printed as a document
* @throws DocFileIOException if there is a problem while writing the document
*/
public void printDocument(Content contentTree) throws DocFileIOException;
void printDocument(Content contentTree) throws DocFileIOException;
/**
* Return the TypeElement being documented.
*
* @return the TypeElement being documented.
*/
public TypeElement getTypeElement();
TypeElement getTypeElement();
/**
* Get the member summary tree.
@ -204,7 +204,7 @@ public interface ClassWriter {
* @param memberTree the content tree used to build the summary tree
* @return a content tree for the member summary
*/
public Content getMemberSummaryTree(Content memberTree);
Content getMemberSummaryTree(Content memberTree);
/**
* Get the member details tree.
@ -212,5 +212,5 @@ public interface ClassWriter {
* @param memberTree the content tree used to build the details tree
* @return a content tree for the member details
*/
public Content getMemberDetailsTree(Content memberTree);
Content getMemberDetailsTree(Content memberTree);
}

View file

@ -49,14 +49,14 @@ public interface ConstantsSummaryWriter {
*
* @return header that needs to be added to the documentation
*/
public abstract Content getHeader();
Content getHeader();
/**
* Get the header for the constant content list.
*
* @return content header that needs to be added to the documentation
*/
public abstract Content getContentsHeader();
Content getContentsHeader();
/**
* Adds the given package name link to the constant content list tree.
@ -66,22 +66,22 @@ public interface ConstantsSummaryWriter {
* been indexed, we want to index utmost once.
* @param contentListTree the content tree to which the link will be added
*/
public abstract void addLinkToPackageContent(PackageElement pkg,
Set<PackageElement> writtenPackageHeaders, Content contentListTree);
void addLinkToPackageContent(PackageElement pkg, Set<PackageElement> writtenPackageHeaders,
Content contentListTree);
/**
* Add the content list to the documentation tree.
*
* @param contentListTree the content that will be added to the list
*/
public abstract void addContentsList(Content contentListTree);
void addContentsList(Content contentListTree);
/**
* Get the constant summaries for the document.
*
* @return constant summaries header to be added to the documentation tree
*/
public abstract Content getConstantSummaries();
Content getConstantSummaries();
/**
* Adds the given package name.
@ -94,14 +94,14 @@ public interface ConstantsSummaryWriter {
* @param first true if the first package is listed
* be written
*/
public abstract void addPackageName(PackageElement pkg, Content summariesTree, boolean first);
void addPackageName(PackageElement pkg, Content summariesTree, boolean first);
/**
* Get the class summary header for the constants summary.
*
* @return the header content for the class constants summary
*/
public abstract Content getClassConstantHeader();
Content getClassConstantHeader();
/**
* Add the content list to the documentation summaries tree.
@ -109,30 +109,30 @@ public interface ConstantsSummaryWriter {
* @param summariesTree the tree to which the class constants list will be added
* @param classConstantTree the class constant tree that will be added to the list
*/
public abstract void addClassConstant(Content summariesTree, Content classConstantTree);
void addClassConstant(Content summariesTree, Content classConstantTree);
/**
* Adds the constant member table to the documentation tree.
*
* @param typeElement the class whose constants are being documented.
* @param fields the constants being documented.
* @param classConstantTree the documentation tree to which theconstant member
* @param classConstantTree the documentation tree to which the constant member
* table content will be added
*/
public abstract void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,
Content classConstantTree);
void addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields,
Content classConstantTree);
/**
* Add the summaries list to the content tree.
*
* @param summariesTree the summaries content tree that will be added to the list
*/
public abstract void addConstantSummaries(Content summariesTree);
void addConstantSummaries(Content summariesTree);
/**
* Adds the footer for the summary documentation.
*/
public abstract void addFooter();
void addFooter();
/**
* Print the constants summary document.
@ -140,6 +140,5 @@ public interface ConstantsSummaryWriter {
* @param contentTree content tree which should be printed
* @throws DocFileIOException if there is a problem while writing the document
*/
public abstract void printDocument(Content contentTree) throws DocFileIOException;
void printDocument(Content contentTree) throws DocFileIOException;
}

View file

@ -46,8 +46,8 @@ public interface ConstructorWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the constructor details header
*/
public Content getConstructorDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
Content getConstructorDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
/**
* Get the constructor documentation tree header.
@ -56,8 +56,8 @@ public interface ConstructorWriter {
* @param constructorDetailsTree the content tree representing constructor details
* @return content tree for the constructor documentation header
*/
public Content getConstructorDocTreeHeader(ExecutableElement constructor,
Content constructorDetailsTree);
Content getConstructorDocTreeHeader(ExecutableElement constructor,
Content constructorDetailsTree);
/**
* Get the signature for the given constructor.
@ -65,7 +65,7 @@ public interface ConstructorWriter {
* @param constructor the constructor being documented
* @return content tree for the constructor signature
*/
public Content getSignature(ExecutableElement constructor);
Content getSignature(ExecutableElement constructor);
/**
* Add the deprecated output for the given constructor.
@ -73,7 +73,7 @@ public interface ConstructorWriter {
* @param constructor the constructor being documented
* @param constructorDocTree content tree to which the deprecated information will be added
*/
public void addDeprecated(ExecutableElement constructor, Content constructorDocTree);
void addDeprecated(ExecutableElement constructor, Content constructorDocTree);
/**
* Add the comments for the given constructor.
@ -81,7 +81,7 @@ public interface ConstructorWriter {
* @param constructor the constructor being documented
* @param constructorDocTree the content tree to which the comments will be added
*/
public void addComments(ExecutableElement constructor, Content constructorDocTree);
void addComments(ExecutableElement constructor, Content constructorDocTree);
/**
* Add the tags for the given constructor.
@ -89,7 +89,7 @@ public interface ConstructorWriter {
* @param constructor the constructor being documented
* @param constructorDocTree the content tree to which the tags will be added
*/
public void addTags(ExecutableElement constructor, Content constructorDocTree);
void addTags(ExecutableElement constructor, Content constructorDocTree);
/**
* Get the constructor details tree.
@ -98,7 +98,7 @@ public interface ConstructorWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the constructor details
*/
public Content getConstructorDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
Content getConstructorDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
/**
* Get the constructor documentation.
@ -106,19 +106,19 @@ public interface ConstructorWriter {
* @param constructorDocTree the content tree representing constructor documentation
* @return content tree for the constructor documentation
*/
public Content getConstructorDoc(Content constructorDocTree);
Content getConstructorDoc(Content constructorDocTree);
/**
* Let the writer know whether a non public constructor was found.
*
* @param foundNonPubConstructor true if we found a non public constructor.
*/
public void setFoundNonPubConstructor(boolean foundNonPubConstructor);
void setFoundNonPubConstructor(boolean foundNonPubConstructor);
/**
* Gets the member header tree.
*
* @return a content tree for the member header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
}

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2017, 2019, 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,7 +39,7 @@ import java.util.Set;
public interface DocletElement extends Element {
public default TypeMirror asType() {
default TypeMirror asType() {
throw new UnsupportedOperationException("Unsupported method");
}
@ -102,7 +102,7 @@ public interface DocletElement extends Element {
/**
* Sub kind enums that this element supports.
*/
public static enum Kind {
enum Kind {
OVERVIEW, DOCFILE;
}
}

View file

@ -46,8 +46,8 @@ public interface EnumConstantWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the enum constants details header
*/
public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
/**
* Get the enum constants documentation tree header.
@ -56,8 +56,8 @@ public interface EnumConstantWriter {
* @param enumConstantsDetailsTree the content tree representing enum constant details
* @return content tree for the enum constant documentation header
*/
public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
Content enumConstantsDetailsTree);
Content getEnumConstantsTreeHeader(VariableElement enumConstant,
Content enumConstantsDetailsTree);
/**
* Get the signature for the given enum constant.
@ -65,7 +65,7 @@ public interface EnumConstantWriter {
* @param enumConstant the enum constant being documented
* @return content tree for the enum constant signature
*/
public Content getSignature(VariableElement enumConstant);
Content getSignature(VariableElement enumConstant);
/**
* Add the deprecated output for the given enum constant.
@ -73,7 +73,7 @@ public interface EnumConstantWriter {
* @param enumConstant the enum constant being documented
* @param enumConstantsTree content tree to which the deprecated information will be added
*/
public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree);
void addDeprecated(VariableElement enumConstant, Content enumConstantsTree);
/**
* Add the comments for the given enum constant.
@ -81,7 +81,7 @@ public interface EnumConstantWriter {
* @param enumConstant the enum constant being documented
* @param enumConstantsTree the content tree to which the comments will be added
*/
public void addComments(VariableElement enumConstant, Content enumConstantsTree);
void addComments(VariableElement enumConstant, Content enumConstantsTree);
/**
* Add the tags for the given enum constant.
@ -89,7 +89,7 @@ public interface EnumConstantWriter {
* @param enumConstant the enum constant being documented
* @param enumConstantsTree the content tree to which the tags will be added
*/
public void addTags(VariableElement enumConstant, Content enumConstantsTree);
void addTags(VariableElement enumConstant, Content enumConstantsTree);
/**
* Get the enum constants details tree.
@ -97,7 +97,7 @@ public interface EnumConstantWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the enum constant details
*/
public Content getEnumConstantsDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
Content getEnumConstantsDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
/**
* Get the enum constants documentation.
@ -105,12 +105,12 @@ public interface EnumConstantWriter {
* @param enumConstantsTree the content tree representing enum constants documentation
* @return content tree for the enum constants documentation
*/
public Content getEnumConstants(Content enumConstantsTree);
Content getEnumConstants(Content enumConstantsTree);
/**
* Gets the member header tree.
*
* @return a content tree for the member header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
}

View file

@ -47,8 +47,7 @@ public interface FieldWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the field details header
*/
public Content getFieldDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
Content getFieldDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree);
/**
* Get the field documentation tree header.
@ -57,8 +56,7 @@ public interface FieldWriter {
* @param fieldDetailsTree the content tree representing field details
* @return content tree for the field documentation header
*/
public Content getFieldDocTreeHeader(VariableElement field,
Content fieldDetailsTree);
Content getFieldDocTreeHeader(VariableElement field, Content fieldDetailsTree);
/**
* Get the signature for the given field.
@ -66,7 +64,7 @@ public interface FieldWriter {
* @param field the field being documented
* @return content tree for the field signature
*/
public Content getSignature(VariableElement field);
Content getSignature(VariableElement field);
/**
* Add the deprecated output for the given field.
@ -74,7 +72,7 @@ public interface FieldWriter {
* @param field the field being documented
* @param fieldDocTree content tree to which the deprecated information will be added
*/
public void addDeprecated(VariableElement field, Content fieldDocTree);
void addDeprecated(VariableElement field, Content fieldDocTree);
/**
* Add the comments for the given field.
@ -82,7 +80,7 @@ public interface FieldWriter {
* @param field the field being documented
* @param fieldDocTree the content tree to which the comments will be added
*/
public void addComments(VariableElement field, Content fieldDocTree);
void addComments(VariableElement field, Content fieldDocTree);
/**
* Add the tags for the given field.
@ -90,7 +88,7 @@ public interface FieldWriter {
* @param field the field being documented
* @param fieldDocTree the content tree to which the tags will be added
*/
public void addTags(VariableElement field, Content fieldDocTree);
void addTags(VariableElement field, Content fieldDocTree);
/**
* Get the field details tree.
@ -99,7 +97,7 @@ public interface FieldWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the field details
*/
public Content getFieldDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
Content getFieldDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
/**
* Get the field documentation.
@ -107,12 +105,12 @@ public interface FieldWriter {
* @param fieldDocTree the content tree representing field documentation
* @return content tree for the field documentation
*/
public Content getFieldDoc(Content fieldDocTree);
Content getFieldDoc(Content fieldDocTree);
/**
* Gets the member header tree.
*
* @return a content tree for the member header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
}

View file

@ -50,8 +50,7 @@ public interface MemberSummaryWriter {
* @param memberSummaryTree the content tree to which the member summary will be added
* @return a content tree for the member summary header
*/
public Content getMemberSummaryHeader(TypeElement typeElement,
Content memberSummaryTree);
Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree);
/**
* Get the summary table for the given class.
@ -59,7 +58,7 @@ public interface MemberSummaryWriter {
* @param typeElement the class the summary table belongs to
* @return a content tree for the member summary table
*/
public Content getSummaryTableTree(TypeElement typeElement);
Content getSummaryTableTree(TypeElement typeElement);
/**
* Add the member summary for the given class and member.
@ -68,8 +67,8 @@ public interface MemberSummaryWriter {
* @param member the member that is documented
* @param firstSentenceTags the tags for the sentence being documented
*/
public void addMemberSummary(TypeElement typeElement, Element member,
List<? extends DocTree> firstSentenceTags);
void addMemberSummary(TypeElement typeElement, Element member,
List<? extends DocTree> firstSentenceTags);
/**
* Get the inherited member summary header for the given class.
@ -77,7 +76,7 @@ public interface MemberSummaryWriter {
* @param typeElement the class the summary belongs to
* @return a content tree containing the inherited summary header
*/
public Content getInheritedSummaryHeader(TypeElement typeElement);
Content getInheritedSummaryHeader(TypeElement typeElement);
/**
* Add the inherited member summary for the given class and member.
@ -88,16 +87,16 @@ public interface MemberSummaryWriter {
* @param isLast true if this is the last member in the list
* @param linksTree the content tree to which the links will be added
*/
public void addInheritedMemberSummary(TypeElement typeElement,
Element member, boolean isFirst, boolean isLast,
Content linksTree);
void addInheritedMemberSummary(TypeElement typeElement,
Element member, boolean isFirst, boolean isLast,
Content linksTree);
/**
* Get inherited summary links.
*
* @return a content tree containing the inherited summary links
*/
public Content getInheritedSummaryLinksTree();
Content getInheritedSummaryLinksTree();
/**
* Add the member tree to the member summary tree.
@ -105,7 +104,7 @@ public interface MemberSummaryWriter {
* @param memberSummaryTree the content tree representing the member summary
* @param memberTree the content tree representing the member
*/
public void addMemberTree(Content memberSummaryTree, Content memberTree);
void addMemberTree(Content memberSummaryTree, Content memberTree);
/**
* Get the member tree.
@ -113,5 +112,5 @@ public interface MemberSummaryWriter {
* @param memberTree the content tree representing the member
* @return a content tree for the member
*/
public Content getMemberTree(Content memberTree);
Content getMemberTree(Content memberTree);
}

View file

@ -47,8 +47,7 @@ public interface MethodWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the method details header
*/
public Content getMethodDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree);
/**
* Get the method documentation tree header.
@ -57,8 +56,7 @@ public interface MethodWriter {
* @param methodDetailsTree the content tree representing method details
* @return content tree for the method documentation header
*/
public Content getMethodDocTreeHeader(ExecutableElement method,
Content methodDetailsTree);
Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree);
/**
* Get the signature for the given method.
@ -66,7 +64,7 @@ public interface MethodWriter {
* @param method the method being documented
* @return content tree for the method signature
*/
public Content getSignature(ExecutableElement method);
Content getSignature(ExecutableElement method);
/**
* Add the deprecated output for the given method.
@ -74,7 +72,7 @@ public interface MethodWriter {
* @param method the method being documented
* @param methodDocTree content tree to which the deprecated information will be added
*/
public void addDeprecated(ExecutableElement method, Content methodDocTree);
void addDeprecated(ExecutableElement method, Content methodDocTree);
/**
* Add the comments for the given method.
@ -83,7 +81,7 @@ public interface MethodWriter {
* @param method the method being documented
* @param methodDocTree the content tree to which the comments will be added
*/
public void addComments(TypeMirror holder, ExecutableElement method, Content methodDocTree);
void addComments(TypeMirror holder, ExecutableElement method, Content methodDocTree);
/**
* Add the tags for the given method.
@ -91,7 +89,7 @@ public interface MethodWriter {
* @param method the method being documented
* @param methodDocTree the content tree to which the tags will be added
*/
public void addTags(ExecutableElement method, Content methodDocTree);
void addTags(ExecutableElement method, Content methodDocTree);
/**
* Get the method details tree.
@ -100,7 +98,7 @@ public interface MethodWriter {
* @param methodDetailsTree the content tree representing method details
* @return content tree for the method details
*/
public Content getMethodDetails(Content methodDetailsTreeHeader, Content methodDetailsTree);
Content getMethodDetails(Content methodDetailsTreeHeader, Content methodDetailsTree);
/**
* Get the method documentation.
@ -108,12 +106,12 @@ public interface MethodWriter {
* @param methodDocTree the content tree representing method documentation
* @return content tree for the method documentation
*/
public Content getMethodDoc(Content methodDocTree);
Content getMethodDoc(Content methodDocTree);
/**
* Gets the member header tree.
*
* @return a content tree for the member header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
}

View file

@ -44,21 +44,21 @@ public interface ModuleSummaryWriter {
* @param heading module name.
* @return the header to be added to the content tree
*/
public abstract Content getModuleHeader(String heading);
Content getModuleHeader(String heading);
/**
* Get the header for the module content.
*
* @return a content tree for the module content header
*/
public abstract Content getContentHeader();
Content getContentHeader();
/**
* Get the header for the summary header.
*
* @return a content tree with the summary header
*/
public abstract Content getSummaryHeader();
Content getSummaryHeader();
/**
* Get the header for the summary tree.
@ -66,7 +66,7 @@ public interface ModuleSummaryWriter {
* @param summaryContentTree the content tree.
* @return a content tree with the summary tree
*/
public abstract Content getSummaryTree(Content summaryContentTree);
Content getSummaryTree(Content summaryContentTree);
/**
* Adds the module description.
@ -74,7 +74,7 @@ public interface ModuleSummaryWriter {
* @param moduleContentTree the content tree to which the module description
* will be added
*/
public abstract void addModuleDescription(Content moduleContentTree);
void addModuleDescription(Content moduleContentTree);
/**
* Adds the tag information from the "module-info.java" file to the documentation
@ -83,40 +83,40 @@ public interface ModuleSummaryWriter {
* @param moduleContentTree the content tree to which the module tags will
* be added
*/
public abstract void addModuleTags(Content moduleContentTree);
void addModuleTags(Content moduleContentTree);
/**
* Adds the modules summary to the documentation tree.
*
* @param summaryContentTree the content tree to which the summary will be added
*/
public abstract void addModulesSummary(Content summaryContentTree);
void addModulesSummary(Content summaryContentTree);
/**
* Adds the packages summary to the documentation tree.
*
* @param summaryContentTree the content tree to which the summary will be added
*/
public abstract void addPackagesSummary(Content summaryContentTree);
void addPackagesSummary(Content summaryContentTree);
/**
* Adds the services summary to the documentation tree.
*
* @param summaryContentTree the content tree to which the summary will be added
*/
public abstract void addServicesSummary(Content summaryContentTree);
void addServicesSummary(Content summaryContentTree);
/**
* Adds the module content tree to the documentation tree.
*
* @param moduleContentTree the content tree that will be added
*/
public abstract void addModuleContent(Content moduleContentTree);
void addModuleContent(Content moduleContentTree);
/**
* Adds the footer to the documentation tree.
*/
public abstract void addModuleFooter();
void addModuleFooter();
/**
* Print the module summary document.
@ -124,5 +124,5 @@ public interface ModuleSummaryWriter {
* @param contentTree the content tree that will be printed
* @throws DocFileIOException if there is a problem while writing the document
*/
public abstract void printDocument(Content contentTree) throws DocFileIOException;
void printDocument(Content contentTree) throws DocFileIOException;
}

View file

@ -48,21 +48,21 @@ public interface PackageSummaryWriter {
* @param heading Package name.
* @return the header to be added to the content tree
*/
public abstract Content getPackageHeader(String heading);
Content getPackageHeader(String heading);
/**
* Get the header for the package content.
*
* @return a content tree for the package content header
*/
public abstract Content getContentHeader();
Content getContentHeader();
/**
* Get the header for the package summary.
*
* @return a content tree with the package summary header
*/
public abstract Content getSummaryHeader();
Content getSummaryHeader();
/**
* Adds the table of interfaces to the documentation tree.
@ -70,8 +70,7 @@ public interface PackageSummaryWriter {
* @param interfaces the interfaces to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addInterfaceSummary(SortedSet<TypeElement> interfaces,
Content summaryContentTree);
void addInterfaceSummary(SortedSet<TypeElement> interfaces, Content summaryContentTree);
/**
* Adds the table of classes to the documentation tree.
@ -79,8 +78,7 @@ public interface PackageSummaryWriter {
* @param classes the classes to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addClassSummary(SortedSet<TypeElement> classes,
Content summaryContentTree);
void addClassSummary(SortedSet<TypeElement> classes, Content summaryContentTree);
/**
* Adds the table of enums to the documentation tree.
@ -88,8 +86,7 @@ public interface PackageSummaryWriter {
* @param enums the enums to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addEnumSummary(SortedSet<TypeElement> enums,
Content summaryContentTree);
void addEnumSummary(SortedSet<TypeElement> enums, Content summaryContentTree);
/**
* Adds the table of records to the documentation tree.
@ -97,8 +94,7 @@ public interface PackageSummaryWriter {
* @param records the records to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addRecordSummary(SortedSet<TypeElement> records,
Content summaryContentTree);
void addRecordSummary(SortedSet<TypeElement> records, Content summaryContentTree);
/**
* Adds the table of exceptions to the documentation tree.
@ -106,8 +102,7 @@ public interface PackageSummaryWriter {
* @param exceptions the exceptions to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addExceptionSummary(SortedSet<TypeElement> exceptions,
Content summaryContentTree);
void addExceptionSummary(SortedSet<TypeElement> exceptions, Content summaryContentTree);
/**
* Adds the table of errors to the documentation tree.
@ -115,8 +110,7 @@ public interface PackageSummaryWriter {
* @param errors the errors to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addErrorSummary(SortedSet<TypeElement> errors,
Content summaryContentTree);
void addErrorSummary(SortedSet<TypeElement> errors, Content summaryContentTree);
/**
* Adds the table of annotation types to the documentation tree.
@ -124,8 +118,7 @@ public interface PackageSummaryWriter {
* @param annoTypes the annotation types to document.
* @param summaryContentTree the content tree to which the summaries will be added
*/
public abstract void addAnnotationTypeSummary(SortedSet<TypeElement> annoTypes,
Content summaryContentTree);
void addAnnotationTypeSummary(SortedSet<TypeElement> annoTypes, Content summaryContentTree);
/**
* Adds the package description from the "packages.html" file to the documentation
@ -134,7 +127,7 @@ public interface PackageSummaryWriter {
* @param packageContentTree the content tree to which the package description
* will be added
*/
public abstract void addPackageDescription(Content packageContentTree);
void addPackageDescription(Content packageContentTree);
/**
* Adds the tag information from the "packages.html" file to the documentation
@ -143,7 +136,7 @@ public interface PackageSummaryWriter {
* @param packageContentTree the content tree to which the package tags will
* be added
*/
public abstract void addPackageTags(Content packageContentTree);
void addPackageTags(Content packageContentTree);
/**
* Adds the tag information from the "packages.html" or "package-info.java" file to the
@ -151,12 +144,12 @@ public interface PackageSummaryWriter {
*
* @param packageContentTree the package content tree to be added
*/
public abstract void addPackageContent(Content packageContentTree);
void addPackageContent(Content packageContentTree);
/**
* Adds the footer to the documentation tree.
*/
public abstract void addPackageFooter();
void addPackageFooter();
/**
* Print the package summary document.
@ -164,13 +157,12 @@ public interface PackageSummaryWriter {
* @param contentTree the content tree that will be printed
* @throws DocFileIOException if there is a problem while writing the document
*/
public abstract void printDocument(Content contentTree) throws DocFileIOException;
void printDocument(Content contentTree) throws DocFileIOException;
/**
* Gets the package summary tree.
* @param summaryContentTree the content tree representing the package summary
* @return a content tree for the package summary
*/
public abstract Content getPackageSummary(Content summaryContentTree);
Content getPackageSummary(Content summaryContentTree);
}

View file

@ -46,8 +46,8 @@ public interface PropertyWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the property details header
*/
public Content getPropertyDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
Content getPropertyDetailsTreeHeader(TypeElement typeElement,
Content memberDetailsTree);
/**
* Get the property documentation tree header.
@ -56,8 +56,8 @@ public interface PropertyWriter {
* @param propertyDetailsTree the content tree representing property details
* @return content tree for the property documentation header
*/
public Content getPropertyDocTreeHeader(ExecutableElement property,
Content propertyDetailsTree);
Content getPropertyDocTreeHeader(ExecutableElement property,
Content propertyDetailsTree);
/**
* Get the signature for the given property.
@ -65,7 +65,7 @@ public interface PropertyWriter {
* @param property the property being documented
* @return content tree for the property signature
*/
public Content getSignature(ExecutableElement property);
Content getSignature(ExecutableElement property);
/**
* Add the deprecated output for the given property.
@ -73,7 +73,7 @@ public interface PropertyWriter {
* @param property the property being documented
* @param propertyDocTree content tree to which the deprecated information will be added
*/
public void addDeprecated(ExecutableElement property, Content propertyDocTree);
void addDeprecated(ExecutableElement property, Content propertyDocTree);
/**
* Add the comments for the given property.
@ -81,7 +81,7 @@ public interface PropertyWriter {
* @param property the property being documented
* @param propertyDocTree the content tree to which the comments will be added
*/
public void addComments(ExecutableElement property, Content propertyDocTree);
void addComments(ExecutableElement property, Content propertyDocTree);
/**
* Add the tags for the given property.
@ -89,7 +89,7 @@ public interface PropertyWriter {
* @param property the property being documented
* @param propertyDocTree the content tree to which the tags will be added
*/
public void addTags(ExecutableElement property, Content propertyDocTree);
void addTags(ExecutableElement property, Content propertyDocTree);
/**
* Get the property details tree.
@ -98,7 +98,7 @@ public interface PropertyWriter {
* @param memberDetailsTree the content tree representing member details
* @return content tree for the property details
*/
public Content getPropertyDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
Content getPropertyDetails(Content memberDetailsTreeHeader, Content memberDetailsTree);
/**
* Get the property documentation.
@ -106,12 +106,12 @@ public interface PropertyWriter {
* @param propertyDocTree the content tree representing property documentation
* @return content tree for the property documentation
*/
public Content getPropertyDoc(Content propertyDocTree);
Content getPropertyDoc(Content propertyDocTree);
/**
* Gets the member header tree.
*
* @return a content tree for the member header
*/
public Content getMemberTreeHeader();
Content getMemberTreeHeader();
}

View file

@ -50,21 +50,21 @@ public interface SerializedFormWriter {
* @param header the header to write.
* @return the header content tree
*/
public Content getHeader(String header);
Content getHeader(String header);
/**
* Get the serialized form summaries header.
*
* @return the serialized form summary header tree
*/
public Content getSerializedSummariesHeader();
Content getSerializedSummariesHeader();
/**
* Get the package serialized form header.
*
* @return the package serialized form header tree
*/
public Content getPackageSerializedHeader();
Content getPackageSerializedHeader();
/**
* Add the serialized tree per package to the serialized summaries tree.
@ -72,7 +72,7 @@ public interface SerializedFormWriter {
* @param serializedSummariesTree the serialized tree to which the package serialized tree will be added
* @param packageSerializedTree the serialized tree per package that needs to be added
*/
public void addPackageSerializedTree(Content serializedSummariesTree, Content packageSerializedTree);
void addPackageSerializedTree(Content serializedSummariesTree, Content packageSerializedTree);
/**
* Get the given package header.
@ -80,14 +80,14 @@ public interface SerializedFormWriter {
* @param packageName the package header to write
* @return a content tree for the package header
*/
public Content getPackageHeader(String packageName);
Content getPackageHeader(String packageName);
/**
* Get the serialized class header.
*
* @return a content tree for the serialized class header
*/
public Content getClassSerializedHeader();
Content getClassSerializedHeader();
/**
* Get the heading for the serializable class.
@ -95,14 +95,14 @@ public interface SerializedFormWriter {
* @param typeElement the class being processed
* @return a content tree for the class heading
*/
public Content getClassHeader(TypeElement typeElement);
Content getClassHeader(TypeElement typeElement);
/**
* Get the serial UID info header.
*
* @return a content tree for the serial uid info header
*/
public Content getSerialUIDInfoHeader();
Content getSerialUIDInfoHeader();
/**
* Adds the serial UID info.
@ -111,15 +111,14 @@ public interface SerializedFormWriter {
* @param serialUID the serial UID to print.
* @param serialUidTree the serial UID tree to which the content will be added.
*/
public void addSerialUIDInfo(String header, String serialUID,
Content serialUidTree);
void addSerialUIDInfo(String header, String serialUID, Content serialUidTree);
/**
* Get the class serialize content header.
*
* @return a content tree for the class serialize content header
*/
public Content getClassContentHeader();
Content getClassContentHeader();
/**
* Return an instance of a SerialFieldWriter for a class.
@ -127,7 +126,7 @@ public interface SerializedFormWriter {
* @param typeElement the class
* @return an instance of a SerialFieldWriter.
*/
public SerialFieldWriter getSerialFieldWriter(TypeElement typeElement);
SerialFieldWriter getSerialFieldWriter(TypeElement typeElement);
/**
* Return an instance of a SerialMethodWriter for a class.
@ -135,19 +134,19 @@ public interface SerializedFormWriter {
* @param typeElement the class
* @return an instance of a SerialMethodWriter.
*/
public SerialMethodWriter getSerialMethodWriter(TypeElement typeElement);
SerialMethodWriter getSerialMethodWriter(TypeElement typeElement);
/**
* Add the serialized content to the body content.
*
* @param serializedTreeContent content for serialized data
*/
public void addSerializedContent(Content serializedTreeContent);
void addSerializedContent(Content serializedTreeContent);
/**
* Add the footer.
*/
public void addFooter();
void addFooter();
/**
* Print the serialized form document.
@ -155,7 +154,7 @@ public interface SerializedFormWriter {
* @param serializedTree the content tree that will be printed
* @throws DocFileIOException if there is a problem while writing the document
*/
public abstract void printDocument(Content serializedTree) throws DocFileIOException;
void printDocument(Content serializedTree) throws DocFileIOException;
/**
* Gets the member tree.
@ -163,19 +162,19 @@ public interface SerializedFormWriter {
* @param contentTree the tree used to generate the complete member tree
* @return a content tree for the member
*/
public Content getMemberTree(Content contentTree);
Content getMemberTree(Content contentTree);
/**
* Write the serialized form for a given field.
*/
public interface SerialFieldWriter {
interface SerialFieldWriter {
/**
* Get the serializable field header.
*
* @return serialized fields header content tree
*/
public Content getSerializableFieldsHeader();
Content getSerializableFieldsHeader();
/**
* Get the field content header.
@ -183,7 +182,7 @@ public interface SerializedFormWriter {
* @param isLastContent true if this is the last content to be documented
* @return fields header content tree
*/
public Content getFieldsContentHeader(boolean isLastContent);
Content getFieldsContentHeader(boolean isLastContent);
/**
* Get the fields content.
@ -192,7 +191,7 @@ public interface SerializedFormWriter {
* @param contentTree content tree to which the heading will be added
* @return serializable fields content tree
*/
public Content getSerializableFields(String heading, Content contentTree);
Content getSerializableFields(String heading, Content contentTree);
/**
* Adds the deprecated information for this member.
@ -200,7 +199,7 @@ public interface SerializedFormWriter {
* @param field the field to document.
* @param contentTree content tree to which the deprecated information will be added
*/
public void addMemberDeprecatedInfo(VariableElement field, Content contentTree);
void addMemberDeprecatedInfo(VariableElement field, Content contentTree);
/**
* Adds the description text for this member.
@ -208,7 +207,7 @@ public interface SerializedFormWriter {
* @param field the field to document
* @param contentTree content tree to which the member description will be added
*/
public void addMemberDescription(VariableElement field, Content contentTree);
void addMemberDescription(VariableElement field, Content contentTree);
/**
* Adds the description text for this member represented by the tag.
@ -217,7 +216,7 @@ public interface SerializedFormWriter {
* @param serialFieldTag the field to document (represented by tag)
* @param contentTree content tree to which the member description will be added
*/
public void addMemberDescription(VariableElement field, DocTree serialFieldTag, Content contentTree);
void addMemberDescription(VariableElement field, DocTree serialFieldTag, Content contentTree);
/**
* Adds the tag information for this member.
@ -225,7 +224,7 @@ public interface SerializedFormWriter {
* @param field the field to document
* @param contentTree content tree to which the member tags will be added
*/
public void addMemberTags(VariableElement field, Content contentTree);
void addMemberTags(VariableElement field, Content contentTree);
/**
* Adds the member header.
@ -237,8 +236,8 @@ public interface SerializedFormWriter {
* @param fieldName the name of the field
* @param contentTree content tree to which the member header will be added
*/
public void addMemberHeader(TypeElement fieldType, String fieldTypeStr,
String fieldDimensions, String fieldName, Content contentTree);
void addMemberHeader(TypeElement fieldType, String fieldTypeStr, String fieldDimensions,
String fieldName, Content contentTree);
/**
* Adds the member header.
@ -247,7 +246,7 @@ public interface SerializedFormWriter {
* @param fieldName the name of the field
* @param contentTree content tree to which the member header will be added
*/
public void addMemberHeader(TypeMirror fieldType, String fieldName, Content contentTree);
void addMemberHeader(TypeMirror fieldType, String fieldName, Content contentTree);
/**
* Check to see if overview details should be printed. If
@ -258,20 +257,20 @@ public interface SerializedFormWriter {
* @param field the field to check overview details for
* @return true if overview details need to be printed
*/
public boolean shouldPrintOverview(VariableElement field);
boolean shouldPrintOverview(VariableElement field);
}
/**
* Write the serialized form for a given field.
*/
public interface SerialMethodWriter {
interface SerialMethodWriter {
/**
* Get the serializable method header.
*
* @return serializable methods content tree
*/
public Content getSerializableMethodsHeader();
Content getSerializableMethodsHeader();
/**
* Get the method content header.
@ -279,7 +278,7 @@ public interface SerializedFormWriter {
* @param isLastContent true if this is the last content to be documented
* @return methods content tree
*/
public Content getMethodsContentHeader(boolean isLastContent);
Content getMethodsContentHeader(boolean isLastContent);
/**
* Write the given heading.
@ -288,7 +287,7 @@ public interface SerializedFormWriter {
* @param serializableMethodTree content tree which will be added
* @return serializable methods content tree
*/
public Content getSerializableMethods(String heading, Content serializableMethodTree);
Content getSerializableMethods(String heading, Content serializableMethodTree);
/**
* Write a warning that no serializable methods exist.
@ -296,7 +295,7 @@ public interface SerializedFormWriter {
* @param msg the warning to print
* @return no customization message tree
*/
public Content getNoCustomizationMsg(String msg);
Content getNoCustomizationMsg(String msg);
/**
* Adds the header.
@ -304,7 +303,7 @@ public interface SerializedFormWriter {
* @param member the member to write the header for
* @param methodsContentTree content tree to which the header will be added
*/
public void addMemberHeader(ExecutableElement member, Content methodsContentTree);
void addMemberHeader(ExecutableElement member, Content methodsContentTree);
/**
* Adds the deprecated information for this member.
@ -313,7 +312,7 @@ public interface SerializedFormWriter {
* @param methodsContentTree content tree to which the deprecated
* information will be added
*/
public void addDeprecatedMemberInfo(ExecutableElement member, Content methodsContentTree);
void addDeprecatedMemberInfo(ExecutableElement member, Content methodsContentTree);
/**
* Adds the description for this member.
@ -322,7 +321,7 @@ public interface SerializedFormWriter {
* @param methodsContentTree content tree to which the member
* information will be added
*/
public void addMemberDescription(ExecutableElement member, Content methodsContentTree);
void addMemberDescription(ExecutableElement member, Content methodsContentTree);
/**
* Adds the tag information for this member.
@ -331,6 +330,6 @@ public interface SerializedFormWriter {
* @param methodsContentTree content tree to which the tags
* information will be added
*/
public void addMemberTags(ExecutableElement member, Content methodsContentTree);
void addMemberTags(ExecutableElement member, Content methodsContentTree);
}
}

View file

@ -50,7 +50,7 @@ public interface WriterFactory {
* @return the writer for the constant summary. Return null if this
* writer is not supported by the doclet.
*/
public abstract ConstantsSummaryWriter getConstantsSummaryWriter();
ConstantsSummaryWriter getConstantsSummaryWriter();
/**
* Return the writer for the package summary.
@ -59,7 +59,7 @@ public interface WriterFactory {
* @return the writer for the package summary. Return null if this
* writer is not supported by the doclet.
*/
public abstract PackageSummaryWriter getPackageSummaryWriter(PackageElement packageElement);
PackageSummaryWriter getPackageSummaryWriter(PackageElement packageElement);
/**
* Return the writer for the module summary.
@ -68,7 +68,7 @@ public interface WriterFactory {
* @return the writer for the module summary. Return null if this
* writer is not supported by the doclet.
*/
public abstract ModuleSummaryWriter getModuleSummaryWriter(ModuleElement mdle);
ModuleSummaryWriter getModuleSummaryWriter(ModuleElement mdle);
/**
* Return the writer for a class.
@ -78,7 +78,7 @@ public interface WriterFactory {
* @return the writer for the class. Return null if this
* writer is not supported by the doclet.
*/
public abstract ClassWriter getClassWriter(TypeElement typeElement, ClassTree classTree);
ClassWriter getClassWriter(TypeElement typeElement, ClassTree classTree);
/**
* Return the writer for an annotation type.
@ -87,7 +87,7 @@ public interface WriterFactory {
* @return the writer for the annotation type. Return null if this
* writer is not supported by the doclet.
*/
public abstract AnnotationTypeWriter getAnnotationTypeWriter(TypeElement annotationType);
AnnotationTypeWriter getAnnotationTypeWriter(TypeElement annotationType);
/**
* Return the method writer for a given class.
@ -96,7 +96,7 @@ public interface WriterFactory {
* @return the method writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
public abstract MethodWriter getMethodWriter(ClassWriter classWriter);
MethodWriter getMethodWriter(ClassWriter classWriter);
/**
* Return the annotation type field writer for a given annotation type.
@ -106,9 +106,8 @@ public interface WriterFactory {
* @return the member writer for the given annotation type. Return null if
* this writer is not supported by the doclet.
*/
public abstract AnnotationTypeFieldWriter
getAnnotationTypeFieldWriter(
AnnotationTypeWriter annotationTypeWriter);
AnnotationTypeFieldWriter getAnnotationTypeFieldWriter(
AnnotationTypeWriter annotationTypeWriter);
/**
* Return the annotation type optional member writer for a given annotation
@ -119,9 +118,8 @@ public interface WriterFactory {
* @return the member writer for the given annotation type. Return null if
* this writer is not supported by the doclet.
*/
public abstract AnnotationTypeOptionalMemberWriter
getAnnotationTypeOptionalMemberWriter(
AnnotationTypeWriter annotationTypeWriter);
AnnotationTypeOptionalMemberWriter getAnnotationTypeOptionalMemberWriter(
AnnotationTypeWriter annotationTypeWriter);
/**
* Return the annotation type required member writer for a given annotation type.
@ -131,9 +129,8 @@ public interface WriterFactory {
* @return the member writer for the given annotation type. Return null if
* this writer is not supported by the doclet.
*/
public abstract AnnotationTypeRequiredMemberWriter
getAnnotationTypeRequiredMemberWriter(
AnnotationTypeWriter annotationTypeWriter);
AnnotationTypeRequiredMemberWriter getAnnotationTypeRequiredMemberWriter(
AnnotationTypeWriter annotationTypeWriter);
/**
* Return the enum constant writer for a given class.
@ -142,8 +139,7 @@ public interface WriterFactory {
* @return the enum constant writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
public abstract EnumConstantWriter getEnumConstantWriter(
ClassWriter classWriter);
EnumConstantWriter getEnumConstantWriter(ClassWriter classWriter);
/**
* Return the field writer for a given class.
@ -152,7 +148,7 @@ public interface WriterFactory {
* @return the field writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
public abstract FieldWriter getFieldWriter(ClassWriter classWriter);
FieldWriter getFieldWriter(ClassWriter classWriter);
/**
* Return the property writer for a given class.
@ -161,7 +157,7 @@ public interface WriterFactory {
* @return the property writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
public abstract PropertyWriter getPropertyWriter(ClassWriter classWriter);
PropertyWriter getPropertyWriter(ClassWriter classWriter);
/**
* Return the constructor writer for a given class.
@ -170,8 +166,7 @@ public interface WriterFactory {
* @return the method writer for the give class. Return null if this
* writer is not supported by the doclet.
*/
public abstract ConstructorWriter getConstructorWriter(
ClassWriter classWriter);
ConstructorWriter getConstructorWriter(ClassWriter classWriter);
/**
* Return the specified member summary writer for a given class.
@ -184,8 +179,8 @@ public interface WriterFactory {
*
* @see VisibleMemberTable
*/
public abstract MemberSummaryWriter getMemberSummaryWriter(
ClassWriter classWriter, VisibleMemberTable.Kind memberType);
MemberSummaryWriter getMemberSummaryWriter(ClassWriter classWriter,
VisibleMemberTable.Kind memberType);
/**
* Return the specified member summary writer for a given annotation type.
@ -199,15 +194,15 @@ public interface WriterFactory {
*
* @see VisibleMemberTable
*/
public abstract MemberSummaryWriter getMemberSummaryWriter(
AnnotationTypeWriter annotationTypeWriter, VisibleMemberTable.Kind memberType);
MemberSummaryWriter getMemberSummaryWriter(AnnotationTypeWriter annotationTypeWriter,
VisibleMemberTable.Kind memberType);
/**
* Return the writer for the serialized form.
*
* @return the writer for the serialized form.
*/
public SerializedFormWriter getSerializedFormWriter();
SerializedFormWriter getSerializedFormWriter();
/**
* Return the handler for doc files.

View file

@ -46,9 +46,9 @@ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind;
*/
public abstract class AbstractMemberBuilder extends AbstractBuilder {
final protected TypeElement typeElement;
protected final TypeElement typeElement;
final protected VisibleMemberTable visibleMemberTable;
protected final VisibleMemberTable visibleMemberTable;
/**
* Construct a SubBuilder.
@ -76,7 +76,7 @@ public abstract class AbstractMemberBuilder extends AbstractBuilder {
*
* Build the documentation.
*
* @param contentTree The content tree into which to add the documention
* @param contentTree The content tree into which to add the documentation
* @throws DocletException if there is a problem building the documentation
*/
public abstract void build(Content contentTree) throws DocletException;

View file

@ -136,8 +136,8 @@ public class ConstructorBuilder extends AbstractMemberBuilder {
memberDetailsTree);
Content constructorDetailsTree = writer.getMemberTreeHeader();
for (Element contructor : constructors) {
currentConstructor = (ExecutableElement)contructor;
for (Element constructor : constructors) {
currentConstructor = (ExecutableElement)constructor;
Content constructorDocTree = writer.getConstructorDocTreeHeader(currentConstructor, constructorDetailsTree);
buildSignature(constructorDocTree);

View file

@ -82,7 +82,7 @@ public class EnumConstantBuilder extends AbstractMemberBuilder {
* Construct a new EnumConstantsBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
* @return the new EnumConstantsBuilder
*/

View file

@ -68,7 +68,7 @@ public class FieldBuilder extends AbstractMemberBuilder {
* Construct a new FieldBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
*/
private FieldBuilder(Context context,
@ -83,7 +83,7 @@ public class FieldBuilder extends AbstractMemberBuilder {
* Construct a new FieldBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
* @return the new FieldBuilder
*/

View file

@ -313,7 +313,7 @@ public abstract class MemberSummaryBuilder extends AbstractMemberBuilder {
}
List<? extends DocTree> firstSentenceTags = utils.getFirstSentenceTrees(member);
if (utils.isExecutableElement(member) && firstSentenceTags.isEmpty()) {
//Inherit comments from overriden or implemented method if
//Inherit comments from overridden or implemented method if
//necessary.
DocFinder.Output inheritedDoc =
DocFinder.search(configuration,

View file

@ -71,7 +71,7 @@ public class MethodBuilder extends AbstractMemberBuilder {
* Construct a new MethodBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
*/
private MethodBuilder(Context context,
@ -86,7 +86,7 @@ public class MethodBuilder extends AbstractMemberBuilder {
* Construct a new MethodBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
*
* @return an instance of a MethodBuilder.

View file

@ -68,7 +68,7 @@ public class PropertyBuilder extends AbstractMemberBuilder {
* Construct a new PropertyBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
*/
private PropertyBuilder(Context context,
@ -83,7 +83,7 @@ public class PropertyBuilder extends AbstractMemberBuilder {
* Construct a new PropertyBuilder.
*
* @param context the build context.
* @param typeElement the class whoses members are being documented.
* @param typeElement the class whose members are being documented.
* @param writer the doclet specific writer.
* @return the new PropertyBuilder
*/

View file

@ -77,7 +77,7 @@ doclet.Other_Packages=Other Packages
doclet.Other_Modules=Other Modules
doclet.Notice_taglet_registered=Registered Taglet {0} ...
doclet.Notice_taglet_unseen=Note: Custom tags that were not seen: {0}
doclet.Notice_taglet_overriden=Note: Custom tags that override standard tags: {0}
doclet.Notice_taglet_overridden=Note: Custom tags that override standard tags: {0}
doclet.Notice_taglet_conflict_warn=Note: Custom tags that could override future standard tags: {0}. To avoid potential overrides, use at least one period character (.) in custom tag names.
doclet.Error_taglet_not_registered=Error - Exception {0} thrown while trying to register Taglet {1}...
doclet.Error_invalid_custom_tag_argument=Error - {0} is an invalid argument to the -tag option...

View file

@ -68,7 +68,7 @@ doclet.Other_Packages=\u305D\u306E\u4ED6\u306E\u30D1\u30C3\u30B1\u30FC\u30B8
doclet.Other_Modules=\u305D\u306E\u4ED6\u306E\u30E2\u30B8\u30E5\u30FC\u30EB
doclet.Notice_taglet_registered=\u767B\u9332\u3055\u308C\u305F\u30BF\u30B0\u30EC\u30C3\u30C8{0} ...
doclet.Notice_taglet_unseen=\u6CE8\u610F: \u975E\u8868\u793A\u306E\u30AB\u30B9\u30BF\u30E0\u30FB\u30BF\u30B0: {0}
doclet.Notice_taglet_overriden=\u6CE8\u610F: \u6A19\u6E96\u30BF\u30B0\u3092\u30AA\u30FC\u30D0\u30FC\u30E9\u30A4\u30C9\u3059\u308B\u30AB\u30B9\u30BF\u30E0\u30FB\u30BF\u30B0: {0}
doclet.Notice_taglet_overridden=\u6CE8\u610F: \u6A19\u6E96\u30BF\u30B0\u3092\u30AA\u30FC\u30D0\u30FC\u30E9\u30A4\u30C9\u3059\u308B\u30AB\u30B9\u30BF\u30E0\u30FB\u30BF\u30B0: {0}
doclet.Notice_taglet_conflict_warn=\u6CE8\u610F: \u6A19\u6E96\u30BF\u30B0\u3092\u30AA\u30FC\u30D0\u30FC\u30E9\u30A4\u30C9\u3059\u308B\u53EF\u80FD\u6027\u306E\u3042\u308B\u30AB\u30B9\u30BF\u30E0\u30FB\u30BF\u30B0: {0}\u3002\u30AA\u30FC\u30D0\u30FC\u30E9\u30A4\u30C9\u3092\u907F\u3051\u308B\u305F\u3081\u306B\u3001\u30AB\u30B9\u30BF\u30E0\u30FB\u30BF\u30B0\u540D\u306E\u4E2D\u306B\u5C11\u306A\u304F\u3068\u30821\u3064\u306E\u30D4\u30EA\u30AA\u30C9(.)\u3092\u4F7F\u7528\u3057\u3066\u304F\u3060\u3055\u3044\u3002
doclet.Error_taglet_not_registered=\u30A8\u30E9\u30FC - \u30BF\u30B0\u30EC\u30C3\u30C8{1}\u3092\u767B\u9332\u3057\u3088\u3046\u3068\u3057\u3066\u3044\u308B\u3068\u304D\u306B\u3001\u4F8B\u5916{0}\u304C\u30B9\u30ED\u30FC\u3055\u308C\u307E\u3057\u305F...
doclet.Error_invalid_custom_tag_argument=\u30A8\u30E9\u30FC - {0}\u306F-tag\u30AA\u30D7\u30B7\u30E7\u30F3\u306B\u5BFE\u3057\u3066\u7121\u52B9\u306A\u5F15\u6570\u3067\u3059...

View file

@ -68,7 +68,7 @@ doclet.Other_Packages=\u5176\u4ED6\u7A0B\u5E8F\u5305
doclet.Other_Modules=\u5176\u4ED6\u6A21\u5757
doclet.Notice_taglet_registered=\u6CE8\u518C\u7684 Taglet {0}...
doclet.Notice_taglet_unseen=\u6CE8: \u627E\u4E0D\u5230\u7684\u5B9A\u5236\u6807\u8BB0: {0}
doclet.Notice_taglet_overriden=\u6CE8: \u8986\u76D6\u6807\u51C6\u6807\u8BB0\u7684\u5B9A\u5236\u6807\u8BB0: {0}
doclet.Notice_taglet_overridden=\u6CE8: \u8986\u76D6\u6807\u51C6\u6807\u8BB0\u7684\u5B9A\u5236\u6807\u8BB0: {0}
doclet.Notice_taglet_conflict_warn=\u6CE8: \u53EF\u80FD\u8986\u76D6\u5C06\u6765\u7684\u6807\u51C6\u6807\u8BB0\u7684\u5B9A\u5236\u6807\u8BB0: {0}\u3002\u4E3A\u4E86\u907F\u514D\u51FA\u73B0\u53EF\u80FD\u7684\u8986\u76D6, \u8BF7\u5728\u5B9A\u5236\u6807\u8BB0\u540D\u79F0\u4E2D\u81F3\u5C11\u4F7F\u7528\u4E00\u4E2A\u53E5\u70B9\u5B57\u7B26 (.)\u3002
doclet.Error_taglet_not_registered=\u9519\u8BEF - \u5C1D\u8BD5\u6CE8\u518C Taglet {1}\u65F6\u629B\u51FA\u5F02\u5E38\u9519\u8BEF{0}...
doclet.Error_invalid_custom_tag_argument=\u9519\u8BEF - \u5BF9\u4E8E -tag \u9009\u9879, {0}\u662F\u65E0\u6548\u53C2\u6570...

View file

@ -43,7 +43,7 @@ import static com.sun.source.doctree.DocTree.Kind.INHERIT_DOC;
/**
* An inline Taglet representing the {@code inheritDoc} tag. This tag should only
* be used with a method. It is used to inherit documentation from overriden
* be used with a method. It is used to inherit documentation from overridden
* and implemented methods.
*
* <p><b>This is NOT part of any supported API.

View file

@ -165,5 +165,5 @@ public interface Taglet {
public UnsupportedTagletOperationException(String message) {
super(message);
}
};
}
}

View file

@ -136,9 +136,9 @@ public class TagletManager {
private final Set<String> standardTagsLowercase;
/**
* Keep track of overriden standard tags.
* Keep track of overridden standard tags.
*/
private final Set<String> overridenStandardTags;
private final Set<String> overriddenStandardTags;
/**
* Keep track of the tags that may conflict
@ -188,7 +188,7 @@ public class TagletManager {
public TagletManager(boolean nosince, boolean showversion,
boolean showauthor, boolean javafx,
BaseConfiguration configuration) {
overridenStandardTags = new HashSet<>();
overriddenStandardTags = new HashSet<>();
potentiallyConflictingTags = new HashSet<>();
standardTags = new HashSet<>();
standardTagsLowercase = new HashSet<>();
@ -229,7 +229,7 @@ public class TagletManager {
/**
* Initializes the location TAGLET_PATH which is used to locate the custom taglets.
* @param fileManager the filemanager to load classes and resources.
* @param fileManager the file manager to load classes and resources.
* @param tagletPath the path to the custom taglet.
* @throws IOException if an error occurs while setting the location.
*/
@ -254,7 +254,7 @@ public class TagletManager {
* Adds a new {@code Taglet}. Print a message to indicate whether or not
* the Taglet was registered properly.
* @param classname the name of the class representing the custom tag.
* @param fileManager the filemanager to load classes and resources.
* @param fileManager the file manager to load classes and resources.
*/
public void addCustomTag(String classname, JavaFileManager fileManager) {
try {
@ -272,7 +272,7 @@ public class TagletManager {
/**
* Loads taglets from a taglet path using service loader.
* @param fileManager the filemanager to load the taglets.
* @param fileManager the file manager to load the taglets.
* @throws IOException if an error occurs while getting the service loader.
*/
public void loadTaglets(JavaFileManager fileManager) throws IOException {
@ -333,7 +333,7 @@ public class TagletManager {
*/
private void checkTagName(String name) {
if (standardTags.contains(name)) {
overridenStandardTags.add(name);
overriddenStandardTags.add(name);
} else {
if (name.indexOf('.') == -1) {
potentiallyConflictingTags.add(name);
@ -700,11 +700,11 @@ public class TagletManager {
/**
* Print a list of {@link Taglet}s that might conflict with
* standard tags in the future and a list of standard tags
* that have been overriden.
* that have been overridden.
*/
public void printReport() {
printReportHelper("doclet.Notice_taglet_conflict_warn", potentiallyConflictingTags);
printReportHelper("doclet.Notice_taglet_overriden", overridenStandardTags);
printReportHelper("doclet.Notice_taglet_overridden", overriddenStandardTags);
printReportHelper("doclet.Notice_taglet_unseen", unseenCustomTags);
}

View file

@ -49,7 +49,7 @@ import static jdk.javadoc.doclet.Taglet.Location.*;
*/
public class UserTaglet implements Taglet {
final private jdk.javadoc.doclet.Taglet userTaglet;
private final jdk.javadoc.doclet.Taglet userTaglet;
public UserTaglet(jdk.javadoc.doclet.Taglet t) {
userTaglet = t;

View file

@ -45,7 +45,7 @@ import static com.sun.source.doctree.DocTree.Kind.VALUE;
* fields. This inline tag has an optional field name parameter. If the name is
* specified, the constant value is retrieved from the specified field. A link
* is also created to the specified field. If a name is not specified, the value
* is retrieved for the field that the inline tag appears on. The name is specifed
* 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].
*
* <p><b>This is NOT part of any supported API.

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2003, 2019, 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,7 +31,7 @@
* 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 outputing
* do the tag processing. For example, suppose we are outputting
* &#64;throws tags. The taglet would:
* <ul>
* <li> Retrieve the list of throws tags to be documented.

View file

@ -49,7 +49,7 @@ public class DeprecatedAPIListBuilder {
private final Map<DeprElementKind, SortedSet<Element>> deprecatedMap;
private final BaseConfiguration configuration;
private final Utils utils;
public static enum DeprElementKind {
public enum DeprElementKind {
REMOVAL,
MODULE,
PACKAGE,

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2016, 2019, 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
@ -52,7 +52,7 @@ public class DocFileIOException extends DocletException {
READ,
/** The file was being opened for writing, or being written when the exception occurred. */
WRITE
};
}
/**
* The file that was in use when the exception occurred.

View file

@ -210,7 +210,7 @@ public class DocFinder {
* IOException and the overridden element has throws tags for IOException and
* ZipException, both tags would be inherited because ZipException is a
* subclass of IOException. This subclass of DocFinder.Output allows
* multiple tag inheritence.
* multiple tag inheritance.
*/
public List<DocTree> tagList = new ArrayList<>();

View file

@ -98,7 +98,7 @@ public class Extern {
/**
* The URL or the directory path at which the element documentation will be
* avaliable.
* available.
*/
final DocPath path;

View file

@ -225,7 +225,7 @@ public class Utils {
/**
* @param e1 the first method to compare.
* @param e2 the second method to compare.
* @return true if member1 overrides/hides or is overriden/hidden by member2.
* @return true if member1 overrides/hides or is overridden/hidden by member2.
*/
public boolean executableMembersEqual(ExecutableElement e1, ExecutableElement e2) {
@ -1139,7 +1139,7 @@ public class Utils {
@Override
public TypeElement visitTypeVariable(TypeVariable t, Void p) {
/* TODO, this may not be an optimimal fix.
/* TODO, this may not be an optimal fix.
* if we have an annotated type @DA T, then erasure returns a
* none, in this case we use asElement instead.
*/
@ -1885,7 +1885,7 @@ public class Utils {
}
/**
* Get the qualified type name of a TypeMiror compatible with the Element's
* Get the qualified type name of a TypeMirror compatible with the Element's
* getQualified name, returns the qualified name of the Reference type
* otherwise the primitive name.
* @param t the type whose name is to be obtained.
@ -2572,7 +2572,7 @@ public class Utils {
@Override
public Boolean visitUnknown(Element e, Void p) {
throw new AssertionError("unkown element: " + p);
throw new AssertionError("unknown element: " + e);
}
};
}

View file

@ -169,7 +169,7 @@ public class VisibleMemberTable {
* a. The list may or may not contain simple overridden methods.
* A simple overridden method is one that overrides a super method
* with no specification changes as indicated by the existence of a
* sole &commat;inheritDoc or devoid of any API commments.
* sole &commat;inheritDoc or devoid of any API comments.
* <p>
* b.The list may contain (extra) members, inherited by inaccessible
* super types, primarily package private types. These members are
@ -227,7 +227,7 @@ public class VisibleMemberTable {
}
/**
* Returns the overridden method, if it is simply overridding or the
* Returns the overridden method, if it is simply overriding or the
* method is a member of a package private type, this method is
* primarily used to determine the location of a possible comment.
*
@ -305,7 +305,7 @@ public class VisibleMemberTable {
/**
* Returns true if this table contains visible members of
* the specified kind, including inhertied members.
* the specified kind, including inherited members.
*
* @return true if visible members are present.
*/
@ -901,7 +901,7 @@ public class VisibleMemberTable {
/*
* Search for the method in the list of interfaces. If found check if it is
* overridden by any other subinterface method which this class
* implements. If it is not overidden, add it in the method list.
* implements. If it is not overridden, add it in the method list.
* Do this recursively for all the extended interfaces for each interface
* from the list.
*/

View file

@ -87,7 +87,7 @@ public abstract class LinkFactory {
@Override
public Content visitArray(ArrayType type, LinkInfo linkInfo) {
// keep track of the dimension depth and replace the last dimension
// specifier with vararags, when the stack is fully unwound.
// specifier with varargs, when the stack is fully unwound.
currentDepth++;
linkInfo.type = type.getComponentType();
visit(linkInfo.type, linkInfo);

View file

@ -40,7 +40,7 @@ public interface LinkOutput {
*
* @param o the object to append.
*/
public void append(Object o);
void append(Object o);
/**
* Insert the given object into the output sequence.
@ -48,5 +48,5 @@ public interface LinkOutput {
* @param offset the offset.
* @param o the object to be inserted.
*/
public void insert(int offset, Object o);
void insert(int offset, Object o);
}

View file

@ -1030,7 +1030,7 @@ public class ElementsTable {
@Override
public Boolean visitUnknown(Element e, Void p) {
throw new AssertionError("unkown element: " + p);
throw new AssertionError("unknown element: " + e);
}
};
}
@ -1039,7 +1039,7 @@ public class ElementsTable {
@SuppressWarnings("preview")
private class IncludedVisitor extends SimpleElementVisitor14<Boolean, Void> {
final private Set<Element> includedCache;
private final Set<Element> includedCache;
public IncludedVisitor() {
includedCache = new LinkedHashSet<>();
@ -1242,8 +1242,8 @@ public class ElementsTable {
}
}
static EnumSet<AccessKind> getFilterSet(AccessKind acccessValue) {
switch (acccessValue) {
static EnumSet<AccessKind> getFilterSet(AccessKind accessValue) {
switch (accessValue) {
case PUBLIC:
return EnumSet.of(AccessKind.PUBLIC);
case PROTECTED:

View file

@ -221,9 +221,9 @@ public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler {
// Ensure that package-info is read for all included packages
for (Element e : etable.getIncludedElements()) {
if (e.getKind() == ElementKind.PACKAGE) {
PackageSymbol packge = (PackageSymbol) e;
if (packge.package_info != null) {
packge.package_info.complete();
PackageSymbol p = (PackageSymbol) e;
if (p.package_info != null) {
p.package_info.complete();
}
}
}
@ -290,7 +290,7 @@ public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler {
}
/** Are surrogates supported? */
final static boolean surrogatesSupported = surrogatesSupported();
static final boolean surrogatesSupported = surrogatesSupported();
private static boolean surrogatesSupported() {
try {
boolean b = Character.isHighSurrogate('a');

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2019, 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
@ -88,7 +88,7 @@ public class Main {
return jdoc.begin(args).exitCode;
}
public static enum Result {
public enum Result {
/** completed with no errors */
OK(0),
/** Completed with reported errors */

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2019, 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
@ -452,7 +452,7 @@ public enum ToolOption {
return null;
}
static abstract class Helper {
abstract static class Helper {
// File manager options
final Map<Option, String> fileManagerOpts = new LinkedHashMap<>();

View file

@ -26,7 +26,7 @@
/**
* Defines the implementation of the
* {@linkplain javax.tools.ToolProvider#getSystemDocumentationTool system documentation tool}
* and its command line equivalent, <em>{@index javadoc javadoc tool}</em>.
* and its command-line equivalent, <em>{@index javadoc javadoc tool}</em>.
*
* <h2 style="font-family:'DejaVu Sans Mono', monospace; font-style:italic">javadoc</h2>
*
@ -71,4 +71,3 @@ module jdk.javadoc {
provides javax.tools.Tool with
jdk.javadoc.internal.api.JavadocTool;
}