summaryrefslogtreecommitdiff
path: root/java/com/google/devtools/common/options/Option.java
diff options
context:
space:
mode:
authorUlf Adams <ulfjack@google.com>2016-06-27 15:51:23 +0000
committerColin Cross <ccross@android.com>2017-02-16 22:35:24 -0800
commit41de8614889436f5f6e8f11a9cdee4a9524a5cf0 (patch)
tree0cbc6384c0a8c2e9392a20899eddf7ab32fc4ef1 /java/com/google/devtools/common/options/Option.java
parent341faa150e5bfc14827a01b63a93f3eb7d1a0ecd (diff)
downloaddesugar-41de8614889436f5f6e8f11a9cdee4a9524a5cf0.tar.gz
Polish the command-line reference.
- change options to print --foo=value - allow option to specify what "value" should be - update the documentation for the startup options - add some indentation to the descriptions - add some spacing between flag texts -- MOS_MIGRATED_REVID=125960618 GitOrigin-RevId: 6f09666d994b3bd7663eb3f95e2aeaf63c85b0d7 Change-Id: I228f26ed2cedf219ab1d32befde8ba765f33fc5a
Diffstat (limited to 'java/com/google/devtools/common/options/Option.java')
-rw-r--r--java/com/google/devtools/common/options/Option.java7
1 files changed, 6 insertions, 1 deletions
diff --git a/java/com/google/devtools/common/options/Option.java b/java/com/google/devtools/common/options/Option.java
index e269d33..3b2ca30 100644
--- a/java/com/google/devtools/common/options/Option.java
+++ b/java/com/google/devtools/common/options/Option.java
@@ -25,7 +25,6 @@ import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Option {
-
/**
* The name of the option ("--name").
*/
@@ -42,6 +41,12 @@ public @interface Option {
String help() default "";
/**
+ * A short text string to describe the type of the expected value. E.g., <code>regex</code>. This
+ * is ignored for boolean, tristate, boolean_or_enum, and void options.
+ */
+ String valueHelp() default "";
+
+ /**
* The default value for the option. This method should only be invoked
* directly by the parser implementation. Any access to default values
* should go via the parser to allow for application specific defaults.