Package org.jdrupes.mdoclet.internal.doclint

Klasse DocLint

java.lang.Object

com.sun.tools.doclint.DocLint

org.jdrupes.mdoclet.internal.doclint.DocLint

Alle implementierten Schnittstellen:

Plugin

public class DocLint
extends com.sun.tools.doclint.DocLint

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

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
class	DocLint.BadArgs

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	SEPARATOR
static final String	XCHECK_PACKAGE
static final String	XCUSTOM_TAGS_PREFIX
static final String	XMSGS_CUSTOM_PREFIX
static final String	XMSGS_OPTION

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DocLint()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getName()
void	init(DocTrees trees, Elements elements, Types types, String... args)	Initialize DocLint with the given utility objects and arguments.
void	init(JavacTask task, String... args)
void	init(JavacTask task, String[] args, boolean addTaskListener)	Initialize DocLint for use with a JavacTask.
boolean	isGroupEnabled(Messages.Group group, Env.AccessKind accessKind)
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)
boolean	shouldCheck(CompilationUnitTree unit)

Von Klasse geerbte Methoden com.sun.tools.doclint.DocLint

newDocLint

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden com.sun.source.util.Plugin

autoStart

Felddetails

XMSGS_OPTION

public static final String XMSGS_OPTION

Siehe auch:

• Konstantenfeldwerte

XMSGS_CUSTOM_PREFIX

public static final String XMSGS_CUSTOM_PREFIX

Siehe auch:

• Konstantenfeldwerte

XCUSTOM_TAGS_PREFIX

public static final String XCUSTOM_TAGS_PREFIX

Siehe auch:

• Konstantenfeldwerte

XCHECK_PACKAGE

public static final String XCHECK_PACKAGE

Siehe auch:

• Konstantenfeldwerte

SEPARATOR

public static final String SEPARATOR

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

DocLint

public DocLint()

Methodendetails

main

public static void main(String... args)

run

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

Simple API entry point.

Parameter:

args - Options and operands for doclint

Löst aus:

DocLint.BadArgs - if an error is detected in any args

IOException - if there are problems with any of the file arguments

run

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

Löst aus:

DocLint.BadArgs

IOException

getName

public String getName()

init

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

init

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

Initialize DocLint for use with a JavacTask.

Strict reference checks are not enabled by default.

Parameter:

task - the task

args - arguments to configure DocLint

addTaskListener - whether or not to register a TaskListener to invoke DocLint

init

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.

Parameter:

trees - the DocTrees utility class

elements - the Elements utility class

types - the Types utility class

args - arguments to configure DocLint

scan

public void scan(TreePath p)

shouldCheck

public boolean shouldCheck(CompilationUnitTree unit)

reportStats

public void reportStats(PrintWriter out)

isValidOption

public boolean isValidOption(String opt)

Angegeben von:

isValidOption in Klasse com.sun.tools.doclint.DocLint

isGroupEnabled

public boolean isGroupEnabled(Messages.Group group,
 Env.AccessKind accessKind)