org.hyphenType.documentation.lib
Annotation Type StandardFormatterEngine.StandardFormatter

@Retention(value=RUNTIME)
@Target(value=TYPE)
public static @interface StandardFormatterEngine.StandardFormatter

Annotation to configure the StandardFormatterEngine.

Author:

Aurelio Akira M. Matsui

Optional Element Summary

int	descriptionIndent The number of characters before the description text.
boolean	lineBreakAtSpace Whether lines should only break at spaces or if lines can break in the middle of a word.
int	maxColumn The maximum number of columns before a line break.
String	options The "options" label.
String	program The label that represents the executing program.
String	statusCode The "Status code" label.
String	usage The "usage" label.

program

public abstract String program

The label that represents the executing program.

Default:

"program"

usage

public abstract String usage

The "usage" label.

Default:

"usage"

options

public abstract String options

The "options" label.

Default:

"options"

statusCode

public abstract String statusCode

The "Status code" label.

Default:

"Status code"

lineBreakAtSpace

public abstract boolean lineBreakAtSpace

Whether lines should only break at spaces or if lines can break in the middle of a word.

Default:

true

descriptionIndent

public abstract int descriptionIndent

The number of characters before the description text.

Default:

20

maxColumn

public abstract int maxColumn

The maximum number of columns before a line break. This value should be larger than descriptionIndent.

Default:

80