org.incava.doctorj

Class Options

public class Options extends OptionSet

Options for Javadoc processing, supporting: doctorj (just errors) doctorj --public (warning level of 0; public methods) doctorj --protected (warning level of 1) doctorj --package (warning level of 2) doctorj --private (warning level of 3) doctorj --pedantic (warning level at max)
Field Summary
static intDEFAULT_WARNING_LEVEL
static booleanemacsOutput
Whether to use single-line (emacs) or multi-line (non-emacs) output format.
static intMAXIMUM_WARNING_LEVEL
static intMINIMUM_WARNING_LEVEL
static Stringsource
The Java source version.
static StringVERSION
The version.
static intwarningLevel
The strictness level, for warnings.
Constructor Summary
protected Options()
Method Summary
static Optionsget()
String[]process(String[] args)
Processes the run control files and command line arguments, and sets the static variables.

Field Detail

DEFAULT_WARNING_LEVEL

public static int DEFAULT_WARNING_LEVEL

emacsOutput

public static boolean emacsOutput
Whether to use single-line (emacs) or multi-line (non-emacs) output format. The emacs form is most suitable for IDEs, which expect single-line output.

MAXIMUM_WARNING_LEVEL

public static int MAXIMUM_WARNING_LEVEL

MINIMUM_WARNING_LEVEL

public static int MINIMUM_WARNING_LEVEL

source

public static String source
The Java source version.

VERSION

public static String VERSION
The version.

warningLevel

public static int warningLevel
The strictness level, for warnings.

Constructor Detail

Options

protected Options()

Method Detail

get

public static Options get()

process

public String[] process(String[] args)
Processes the run control files and command line arguments, and sets the static variables. Returns the arguments that were not consumed by option processing.