Repository: karaf Updated Branches: refs/heads/master f1307836a -> b8493ae83
KARAF-2795 Improved javadoc for @Option Project: http://git-wip-us.apache.org/repos/asf/karaf/repo Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/b8493ae8 Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/b8493ae8 Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/b8493ae8 Branch: refs/heads/master Commit: b8493ae83ed1ed8ab745adc2ba58d08e1376e2d4 Parents: f130783 Author: Christian Schneider <[email protected]> Authored: Thu May 8 13:29:10 2014 +0200 Committer: Christian Schneider <[email protected]> Committed: Thu May 8 13:29:10 2014 +0200 ---------------------------------------------------------------------- .../src/main/java/org/apache/karaf/shell/api/action/Option.java | 2 ++ 1 file changed, 2 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/karaf/blob/b8493ae8/shell/core/src/main/java/org/apache/karaf/shell/api/action/Option.java ---------------------------------------------------------------------- diff --git a/shell/core/src/main/java/org/apache/karaf/shell/api/action/Option.java b/shell/core/src/main/java/org/apache/karaf/shell/api/action/Option.java index e416bca..66065d4 100644 --- a/shell/core/src/main/java/org/apache/karaf/shell/api/action/Option.java +++ b/shell/core/src/main/java/org/apache/karaf/shell/api/action/Option.java @@ -26,6 +26,8 @@ import java.lang.annotation.Target; /** * Used to mark an optional named command line option who's name typically starts with "--" or "-". * This annotation can be applied to attributes of a class implementing an Action. + * The value of the command line option will be automatically converted to the attribute type. + * @see org.apache.karaf.shell.support.converter.DefaultConverter * <p> * <h2>Example 1 (boolean option):</h2> * <code>@Option(name="--force") boolean force;</code>
