Package io.muserver.rest

Annotation Type Description

  • @Target({TYPE,METHOD,PARAMETER})
@Retention(RUNTIME)
@Documented
public @interface Description
    Provides a description of a class, method, or parameter for use in documentation.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      A short plaintext summary.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String details
      An optional, detailed description that may include CommonMark Markdown.
      java.lang.String documentationUrl
      An optional URL pointing to more documentation for this.
      java.lang.String example
      An example value

    • Element Detail

      • value

        java.lang.String value
        A short plaintext summary.
        Returns:
        The summary

      • details

        java.lang.String details
        An optional, detailed description that may include CommonMark Markdown.
        Returns:
        The description
        Default:
        ""

      • documentationUrl

        java.lang.String documentationUrl
        An optional URL pointing to more documentation for this.
        Returns:
        The URL
        Default:
        ""

      • example

        java.lang.String example
        An example value
        Returns:
        An example value
        Default:
        ""