Annotation Interface Tutorial

@Target(TYPE) @Retention(RUNTIME) public @interface Tutorial
Marks a class as a tutorial for the website. The source file is processed by the tutorial generator to produce documentation pages with interleaved prose and code.

Block comments (/* ... * /) become explanatory text. Code between comments becomes syntax-highlighted code blocks.

  • 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 shown in the tutorial index.
    int
    order
    Order within category (lower = first).

  • Element Details

    • title

      String title
      Title shown on the website.

    • category

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

    • order

      int order
      Order within category (lower = first). Defaults to filename prefix.
      Default:
      -1

    • description

      String description
      Short description shown in the tutorial index.
      Default:
      ""