Package org.plumelib.options
Annotation Type OptionGroup
Indicates which
@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 firstOption = blah;
instead of
@OptionGroup("the group") /** comment for first option*/ @Option("the first option") public static int firstOption = blah;
- See Also:
-
Required Element Summary
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionboolean
Whether this option group is unpublicized.
-
Element Details
-
-
unpublicized
boolean unpublicizedWhether this option group is unpublicized.- Returns:
- true if this option group is unpublicized, false if it is publicized
- Default:
- false
-