Annotation Interface Examples

@Retention(RUNTIME) @Target(TYPE) @Documented public @interface Examples
Annotation that provides an examples section for a commands help

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    descriptions
    An array of paragraphs of text where each paragraph described the corresponding example given in the examples() property.
    String[]
    examples
    An array of lines of text to provide a series of example usages of the command.

  • Element Details

    • examples

      String[] examples
      An array of lines of text to provide a series of example usages of the command. Each example may be provided with a description using the descriptions() property. The data in these two properties is collated based on array indices.
      Returns:
      Examples
      Default:
      {}

    • descriptions

      String[] descriptions
      An array of paragraphs of text where each paragraph described the corresponding example given in the examples() property. The data in these two properties is collated based on array indices.
      Returns:
      Descriptions
      Default:
      {}