Update comments about the option processor.

There were a few places where the current state of the world was not clear.

RELNOTES: None.
PiperOrigin-RevId: 167273651
GitOrigin-RevId: a8c00e2f40ab8a57e3630e774e8d0d9354f38472
Change-Id: Ic7293724cf4789bef63284604f1a3eb2c2f61b86

1 files changed, 5 insertions, 3 deletions

diff --git a/java/com/google/devtools/common/options/Option.java b/java/com/google/devtools/common/options/Option.java
index 829f9e9..4a65f69 100644
--- a/java/com/google/devtools/common/options/Option.java
+++ b/java/com/google/devtools/common/options/Option.java
@@ -23,6 +23,9 @@ import java.lang.annotation.Target;
  *
  * <p>The fields of this annotation have matching getters in {@link OptionDefinition}. Please do not
  * access these fields directly, but instead go through that class.
+ *
+ * <p>A number of checks are run on an Option's fields' values at compile time. See
+ * {@link com.google.devtools.common.options.processor.OptionProcessor} for details.
  */
 @Target(ElementType.FIELD)
 @Retention(RetentionPolicy.RUNTIME)
@@ -85,9 +88,6 @@ public @interface Option {
    *
    * <p>For undocumented flags that aren't listed anywhere, set this to
    * OptionDocumentationCategory.UNDOCUMENTED.
-   *
-   * <p>For hidden or internal options, please set this as UNDOCUMENTED and set the specific reason
-   * for this state in the metadataTags() field.
    */
   OptionDocumentationCategory documentationCategory();
 
@@ -107,6 +107,8 @@ public @interface Option {
    *
    * <p>If one or more of the OptionMetadataTag values apply, please include, but otherwise, this
    * list can be left blank.
+   *
+   * <p>Hidden or internal options must be UNDOCUMENTED (set in {@link #documentationCategory()}).
    */
   OptionMetadataTag[] metadataTags() default {};