org.incava.doctorj
Class Options

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

Constructor Summary

protected

Options()

Method Summary

static Options	get()
java.lang.String[]	process(java.lang.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, processCommandLine, processRunControlFiles, showConfig, showUsage

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_WARNING_LEVEL

public static int MAXIMUM_WARNING_LEVEL

MINIMUM_WARNING_LEVEL

public static int MINIMUM_WARNING_LEVEL

DEFAULT_WARNING_LEVEL

public static int DEFAULT_WARNING_LEVEL

warningLevel

public static int warningLevel

The strictness level, for warnings.

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.

VERSION

public static java.lang.String VERSION

The version.

source

public static java.lang.String source

The Java source version.

Constructor Detail

Options

protected Options()

Method Detail

get

public static Options get()

process

public java.lang.String[] process(java.lang.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 class OptionSet