[
https://issues.apache.org/jira/browse/KARAF-2795?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Christian Schneider reassigned KARAF-2795:
------------------------------------------
Assignee: Christian Schneider
> @Option annotation class missing documentation
> ----------------------------------------------
>
> Key: KARAF-2795
> URL: https://issues.apache.org/jira/browse/KARAF-2795
> Project: Karaf
> Issue Type: Documentation
> Affects Versions: 3.0.0
> Reporter: Amichai Rothman
> Assignee: Christian Schneider
> Priority: Minor
>
> The @Option annotation used in defining custom shell commands is missing
> javadocs describing its behavior. For one, its options have no explanation.
> Further, its effect on fields of different types is undocumented: when
> applied to a boolean field, it is treated as a switch with no value (e.g.
> --verbose) and the field is set according to whether the switch is specified
> or not, but when applied to a field of any other type it requires a value
> (e.g. --user username), and the command fails if a value is not provided. The
> field in this case receives the value converted to the field type (though
> this is typically just an unconverted String).
> All of this should be documented in the Option class javadoc so that it can
> be used properly.
--
This message was sent by Atlassian JIRA
(v6.1.5#6160)
