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 int
DEFAULT_WARNING_LEVEL
static int
MAXIMUM_WARNING_LEVEL
static int
MINIMUM_WARNING_LEVEL
static String
VERSION
The version.
static boolean
emacsOutput
Whether to use single-line (emacs) or multi-line (non-emacs) output format.
static String
source
The Java source version.
static int
warningLevel
The strictness level, for warnings.

Constructor Summary

Options()

Method Summary

static Options
get()
String[]
process(String[] args)
Processes the run control files and command line arguments, and sets the static variables.

Methods inherited from class org.incava.jagol.OptionSet

add, addRunControlFile, getAppName, getDescription, process, processCommandLine, processRunControlFiles, showConfig, showUsage

Field Details

DEFAULT_WARNING_LEVEL

public static int DEFAULT_WARNING_LEVEL

MAXIMUM_WARNING_LEVEL

public static int MAXIMUM_WARNING_LEVEL

MINIMUM_WARNING_LEVEL

public static int MINIMUM_WARNING_LEVEL

VERSION

public static String VERSION
The version.

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.

source

public static String source
The Java source version.

warningLevel

public static int warningLevel
The strictness level, for warnings.

Constructor Details

Options

protected Options()

Method Details

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.
Overrides:
process in interface OptionSet