Package org.apache.juneau.marshall.markdown

Annotation Interface Markdown

@Documented @Target({TYPE,FIELD,METHOD}) @Retention(RUNTIME) @Inherited public @interface Markdown
Annotation for customizing Markdown serialization and parsing behavior on classes, methods, and fields.

Can be used in the following locations:

  • Marshalled classes/methods/fields.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    code
    Render property value as inline backtick-quoted code.
    String[]
    description
    Optional description for the exposed API.
    MarkdownFormat
    format
    Rendering format override.
    String
    heading
    Custom heading text for document-mode rendering.
    String
    link
    Render property value as a Markdown link using the specified URL template.
    boolean
    noHeaders
    Suppress table header row rendering.
    boolean
    noTables
    Suppress table rendering; force list rendering for collections.

  • Element Details

    • description

      String[] description
      Optional description for the exposed API.
      Returns:
      The annotation value.
      Default:
      {}

    • format

      MarkdownFormat format
      Rendering format override.
      Returns:
      The annotation value.
      Default:
      DEFAULT

    • heading

      String heading
      Custom heading text for document-mode rendering.

      Overrides the property name used as the heading in MarkdownDocSerializer output.

      Returns:
      The annotation value.
      Default:
      ""

    • noTables

      boolean noTables
      Suppress table rendering; force list rendering for collections.

      Mirrors Html.noTables().

      Returns:
      The annotation value.
      Default:
      false

    • noHeaders

      boolean noHeaders
      Suppress table header row rendering.
      Returns:
      The annotation value.
      Default:
      false

    • code

      boolean code
      Render property value as inline backtick-quoted code.
      Returns:
      The annotation value.
      Default:
      false

    • link

      String link
      Render property value as a Markdown link using the specified URL template.

      The template may use "{value}" as a placeholder for the actual property value.

      Returns:
      The annotation value.
      Default:
      ""