Annotation Interface Example

@Target(TYPE) @Retention(RUNTIME) public @interface Example
Marks a class as a website example showcase. Uses the same interleaved block-comment/code pattern as @Tutorial, but produces compact card-style pages with screenshot previews.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    title
    Title shown on the website.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    category
    Category for grouping (e.g., "Getting Started", "Rendering").
    String
    description
    Short description for the example card.
    int
    order
    Order within category (lower = first).
    String
    screenshot
    Screenshot filename (from screenshot tests or manually placed).

  • Element Details

    • title

      String title
      Title shown on the website.

    • description

      String description
      Short description for the example card.
      Default:
      ""

    • category

      String category
      Category for grouping (e.g., "Getting Started", "Rendering").
      Default:
      ""

    • order

      int order
      Order within category (lower = first).
      Default:
      -1

    • screenshot

      String screenshot
      Screenshot filename (from screenshot tests or manually placed).
      Default:
      ""