Annotation Interface Example


@Retention(RUNTIME) @Target(CONSTRUCTOR) public @interface Example
An example of using a function that is rendered in the docs.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The test file that contains the example.
    The tag that fences this example.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    The description that will appear before the example
    The explanation that will appear after the example.
  • Element Details

    • description

      String description
      The description that will appear before the example
      Default:
      ""
    • file

      String file
      The test file that contains the example.
    • tag

      String tag
      The tag that fences this example.
    • explanation

      String explanation
      The explanation that will appear after the example.
      Default:
      ""