@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface OptionGroup
@Option
-annotated fields are part of an option group — a related
set of user-visible features. Option groups are documented in Options
.
Write OptionGroup
on the first field in every group. Every @Option
-annotated
field must be part of a group if any of them are.
@OptionGroup
must appear after a field's Javadoc comment, if any. A Javadoc comment
between @OptionGroup
and the field is ignored. For example, you must write
/** comment for first option */ @OptionGroup("the group") @Option("the first option") public static int first_option = blah;instead of
@OptionGroup("the group") /** comment for first option */ @Option("the first option") public static int first_option = blah;
Options
,
Option
,
Unpublicized
,
OptionsDoclet
Modifier and Type | Required Element and Description |
---|---|
java.lang.String |
value
Name of this option group.
|
Modifier and Type | Optional Element and Description |
---|---|
boolean |
unpublicized
Whether this option group is unpublicized.
|
public abstract java.lang.String value
Options
constructor.