Modifier and Type	Class and Description
public class	DocLint.BadArgs
pack-priv abstract static class	DocLint.DeclScanner

Modifier and Type	Field and Description
pack-priv Checker	checker
pack-priv Env	env
pack-priv List<File>	javacBootClassPath
pack-priv List<File>	javacClassPath
pack-priv List<File>	javacFiles
pack-priv List<String>	javacOpts
pack-priv List<File>	javacSourcePath
pack-priv boolean	needHelp
public static final String	SEPARATOR
private static final String	STATS
public static final String	XCHECK_PACKAGE Hides com.sun.tools.doclint.DocLint.XCHECK_PACKAGE.
public static final String	XCUSTOM_TAGS_PREFIX
public static final String	XMSGS_CUSTOM_PREFIX Hides com.sun.tools.doclint.DocLint.XMSGS_CUSTOM_PREFIX.
public static final String	XMSGS_OPTION Hides com.sun.tools.doclint.DocLint.XMSGS_OPTION.

Access	Constructor and Description
public	DocLint()

Method Summary

Modifier and Type	Method and Description
public String	getName() Implements com.sun.source.util.Plugin.getName. Returns the user-friendly name of this plug-in.
public void	init(JavacTask task, String... args) Implements com.sun.source.util.Plugin.init. Initializes the plug-in for a given compilation task.
public void	init(JavacTask the task task, String[] arguments to configure DocLint args, boolean whether or not to register a `TaskListener` to invoke DocLint addTaskListener) Initialize DocLint for use with a `JavacTask`.
public void	init(DocTrees the `DocTrees` utility class trees, Elements the `Elements` utility class elements, Types the `Types` utility class types, String... arguments to configure DocLint args) Initialize DocLint with the given utility objects and arguments.
public boolean	isGroupEnabled(Messages.Group group, AccessLevel accessLevel)
public boolean	isValidOption(String opt) Implements abstract com.sun.tools.doclint.DocLint.isValidOption.
private String	localize(String code, Object... args)
public static void	main(String... args)
pack-priv void	processArgs(String... args)
private void	processArgs(Env env, String... args)
public void	reportStats(PrintWriter out)
public void	run(String... Options and operands for doclint args) Simple API entry point.
public void	run(PrintWriter out, String... args)
public void	scan(TreePath p)
public boolean	shouldCheck(CompilationUnitTree unit)
pack-priv void	showHelp(PrintWriter out)
private static double	similarity(String a, String b)
pack-priv List<File>	splitPath(String path)
public static List<String>	suggestSimilar(Collection<String> knownTags, String unknownTag)

Inherited from com.sun.tools.doclint.DocLint:: newDocLint

Field Detail

checker	back to summary
pack-priv Checker checker

env	back to summary
pack-priv Env env

javacBootClassPath	back to summary
pack-priv List<File> javacBootClassPath

javacClassPath	back to summary
pack-priv List<File> javacClassPath

javacFiles	back to summary
pack-priv List<File> javacFiles

javacOpts	back to summary
pack-priv List<String> javacOpts

javacSourcePath	back to summary
pack-priv List<File> javacSourcePath

needHelp	back to summary
pack-priv boolean needHelp

SEPARATOR	back to summary
public static final String SEPARATOR

STATS	back to summary
private static final String STATS

XCHECK_PACKAGE	back to summary
public static final String XCHECK_PACKAGE Hides com.sun.tools.doclint.DocLint.XCHECK_PACKAGE.

XCUSTOM_TAGS_PREFIX	back to summary
public static final String XCUSTOM_TAGS_PREFIX

XMSGS_CUSTOM_PREFIX	back to summary
public static final String XMSGS_CUSTOM_PREFIX Hides com.sun.tools.doclint.DocLint.XMSGS_CUSTOM_PREFIX.

XMSGS_OPTION	back to summary
public static final String XMSGS_OPTION Hides com.sun.tools.doclint.DocLint.XMSGS_OPTION.

DocLint	back to summary
public DocLint()

Method Detail

getName	back to summary
public String getName() Implements com.sun.source.util.Plugin.getName. Doc from com.sun.source.util.Plugin.getName. Returns the user-friendly name of this plug-in. Annotations @Override @DefinedBy:COMPILER_TREE

getName

back to summary

public String getName()

Implements com.sun.source.util.Plugin.getName.

Doc from com.sun.source.util.Plugin.getName.

Returns the user-friendly name of this plug-in.

Annotations

@Override
@DefinedBy:COMPILER_TREE

init	back to summary
public void init(JavacTask task, String... args) Implements com.sun.source.util.Plugin.init. Doc from com.sun.source.util.Plugin.init. Initializes the plug-in for a given compilation task. Annotations @Override @DefinedBy:COMPILER_TREE

init

back to summary

public void init(JavacTask task, String... args)

Implements com.sun.source.util.Plugin.init.

Doc from com.sun.source.util.Plugin.init.

Initializes the plug-in for a given compilation task.

Annotations

@Override
@DefinedBy:COMPILER_TREE

init back to summary

init	back to summary
public void init(JavacTask task, String[] args, boolean addTaskListener) Initialize DocLint for use with a `JavacTask`. `Strict reference checks` are not enabled by default. Parameters task:JavacTask the task args:String[] arguments to configure DocLint addTaskListener:boolean whether or not to register a `TaskListener` to invoke DocLint

public void init(JavacTask task, String[] args, boolean addTaskListener)

Initialize DocLint for use with a JavacTask. Strict reference checks are not enabled by default.

Parameters

task:JavacTask: the task
args:String[]: arguments to configure DocLint
addTaskListener:boolean: whether or not to register a TaskListener to invoke DocLint

init back to summary

init	back to summary
public void init(DocTrees trees, Elements elements, Types types, String... args) Initialize DocLint with the given utility objects and arguments. `Strict reference checks` are enabled by default. Parameters trees:DocTrees the `DocTrees` utility class elements:Elements the `Elements` utility class types:Types the `Types` utility class args:String[] arguments to configure DocLint

public void init(DocTrees trees, Elements elements, Types types, String... args)

Initialize DocLint with the given utility objects and arguments. Strict reference checks are enabled by default.

Parameters

trees:DocTrees: the DocTrees utility class
elements:Elements: the Elements utility class
types:Types: the Types utility class
args:String[]: arguments to configure DocLint

isGroupEnabled	back to summary
public boolean isGroupEnabled(Messages.Group group, AccessLevel accessLevel)

isValidOption	back to summary
public boolean isValidOption(String opt) Implements abstract com.sun.tools.doclint.DocLint.isValidOption.

localize	back to summary
private String localize(String code, Object... args)

main	back to summary
public static void main(String... args)

processArgs	back to summary
pack-priv void processArgs(String... args) throws BadArgs

processArgs	back to summary
private void processArgs(Env env, String... args)

reportStats	back to summary
public void reportStats(PrintWriter out)

run	back to summary
public void run(String... args) throws BadArgs, IOException Simple API entry point. Parameters args:String[] Options and operands for doclint Exceptions BadArgs: if an error is detected in any args IOException: if there are problems with any of the file arguments

run

back to summary

public void run(String... args) throws BadArgs, IOException

Simple API entry point.

Parameters

args:String[]: Options and operands for doclint

Exceptions

BadArgs:: if an error is detected in any args
IOException:: if there are problems with any of the file arguments

run	back to summary
public void run(PrintWriter out, String... args) throws BadArgs, IOException

scan	back to summary
public void scan(TreePath p)

shouldCheck	back to summary
public boolean shouldCheck(CompilationUnitTree unit)

showHelp	back to summary
pack-priv void showHelp(PrintWriter out)

similarity	back to summary
private static double similarity(String a, String b)

splitPath	back to summary
pack-priv List<File> splitPath(String path)

suggestSimilar	back to summary
public static List<String> suggestSimilar(Collection<String> knownTags, String unknownTag)

jdk.javadoc.internal.doclint back to summary

public Class DocLint.BadArgs

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
jdk.javadoc.internal.doclint.DocLint.BadArgs

Field Summary

Modifier and Type	Field and Description
pack-priv final transient Object[]	args
pack-priv final String	code
private static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	BadArgs(String code, Object... args)

Field Detail

args	back to summary
pack-priv final transient Object[] args

code	back to summary
pack-priv final String code

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.lang.Exception.serialVersionUID.

Constructor Detail

BadArgs	back to summary
pack-priv BadArgs(String code, Object... args)

jdk.javadoc.internal.doclint back to summary

pack-priv abstract Class DocLint.DeclScanner

Class Inheritance

extends TreePathScanner<Void, Void>

java.lang.Object
com.sun.source.util.TreeScanner
com.sun.source.util.TreePathScanner
jdk.javadoc.internal.doclint.DocLint.DeclScanner

Field Summary

Modifier and Type	Field and Description
pack-priv final Env	env

Constructor Summary

Access	Constructor and Description
public	DeclScanner(Env env)

Method Summary

Modifier and Type	Method and Description
public Void	visitBlock(BlockTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitBlock. Implements com.sun.source.tree.TreeVisitor.visitBlock. Visits a `BlockTree` node.
public Void	visitClass(ClassTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitClass. Implements com.sun.source.tree.TreeVisitor.visitClass. Visits a `ClassTree` node.
public Void	visitCompilationUnit(CompilationUnitTree node, Void p) Overrides com.sun.source.util.TreeScanner.visitCompilationUnit. Implements com.sun.source.tree.TreeVisitor.visitCompilationUnit. Visits a `CompilationUnitTree` node.
pack-priv abstract void	visitDecl(Tree tree, Name name)
public Void	visitLambdaExpression(LambdaExpressionTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitLambdaExpression. Implements com.sun.source.tree.TreeVisitor.visitLambdaExpression. Visits a `LambdaExpressionTree` node.
public Void	visitMethod(MethodTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitMethod. Implements com.sun.source.tree.TreeVisitor.visitMethod. Visits a `MethodTree` node.
public Void	visitModule(ModuleTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitModule. Implements com.sun.source.tree.TreeVisitor.visitModule. Visits a `ModuleTree` node.
public Void	visitPackage(PackageTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitPackage. Implements com.sun.source.tree.TreeVisitor.visitPackage. Visits a `PackageTree` node.
public Void	visitVariable(VariableTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitVariable. Implements com.sun.source.tree.TreeVisitor.visitVariable. Visits a `VariableTree` node.

Inherited from com.sun.source.util.TreePathScanner:: getCurrentPath scan scan

Field Detail

env	back to summary
pack-priv final Env env

Constructor Detail

DeclScanner	back to summary
public DeclScanner(Env env)

Method Detail

visitBlock back to summary

visitBlock	back to summary
public Void visitBlock(BlockTree tree, Void ignore) Overrides com.sun.source.util.TreeScanner.visitBlock. Implements com.sun.source.tree.TreeVisitor.visitBlock. Doc from com.sun.source.util.TreeScanner.visitBlock. Visits a `BlockTree` node. Annotations @Override @DefinedBy:COMPILER_TREE

public Void visitBlock(BlockTree tree, Void ignore)

Overrides com.sun.source.util.TreeScanner.visitBlock.

Implements com.sun.source.tree.TreeVisitor.visitBlock.

Doc from com.sun.source.util.TreeScanner.visitBlock.

Visits a BlockTree node.

Annotations