Package com.sun.tools.doclint

Class DocLint

java.lang.Object

com.sun.tools.doclint.DocLint

All Implemented Interfaces:

Plugin

public class DocLint
extends Object
implements Plugin

Multi-function entry point for the doc check utility. This class can be invoked in the following ways:

• From the command line
• From javac, as a plugin
• Directly, via a simple API

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DocLint.BadArgs

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAGS_SEPARATOR
static String	XCUSTOM_TAGS_PREFIX
static String	XIMPLICIT_HEADERS
static String	XMSGS_CUSTOM_PREFIX
static String	XMSGS_OPTION

Constructor Summary

Constructors

Constructor and Description
DocLint()

Method Summary

Modifier and Type	Method and Description
String	getName() Get the user-friendly name of this plug-in.
void	init(JavacTask task, String... args) Initialize the plug-in for a given compilation task.
void	init(JavacTask task, String[] args, boolean addTaskListener)
static boolean	isValidOption(String opt)
static void	main(String... args)
void	reportStats(PrintWriter out)
void	run(PrintWriter out, String... args)
void	run(String... args) Simple API entry point.
void	scan(TreePath p)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XMSGS_OPTION

public static final String XMSGS_OPTION

See Also:

Constant Field Values

XMSGS_CUSTOM_PREFIX

public static final String XMSGS_CUSTOM_PREFIX

See Also:

Constant Field Values

XIMPLICIT_HEADERS

public static final String XIMPLICIT_HEADERS

See Also:

Constant Field Values

XCUSTOM_TAGS_PREFIX

public static final String XCUSTOM_TAGS_PREFIX

See Also:

Constant Field Values

TAGS_SEPARATOR

public static final String TAGS_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DocLint

public DocLint()

Method Detail

main

public static void main(String... args)

run

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

Simple API entry point.

Throws:

DocLint.BadArgs

IOException

run

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

Throws:

DocLint.BadArgs

IOException

getName

public String getName()

Description copied from interface: Plugin

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

Specified by:

getName in interface Plugin

Returns:

the user-friendly name of the plug-in

init

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

Description copied from interface: Plugin

Initialize the plug-in for a given compilation task.

Specified by:

init in interface Plugin

Parameters:

task - The compilation task that has just been started

args - Arguments, if any, for the plug-in

init

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

scan

public void scan(TreePath p)

reportStats

public void reportStats(PrintWriter out)

isValidOption

public static boolean isValidOption(String opt)