Package net.sourceforge.plantuml.cli

Annotation Interface CliFlagDoc

@Documented @Retention(RUNTIME) @Target(FIELD) public @interface CliFlagDoc
Annotation used to document CLI flags in CliFlag. The value of this annotation typically contains a human-readable description that may be used to generate help messages or documentation automatically.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    A human-readable description of the CLI flag.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    level
     
    String
    newGroup
     
    String
    usage
     

  • Element Details

    • value

      String value
      A human-readable description of the CLI flag.
      Returns:
      the description of the flag

    • level

      int level
      Default:
      999

    • newGroup

      String newGroup
      Default:
      ""

    • usage

      String usage
      Default:
      ""