Package com.linecorp.armeria.server.annotation

Annotation Type Description

@Retention(RUNTIME)
@Target({TYPE,METHOD,PARAMETER})
public @interface Description
An annotation used in annotated HTTP service. This describes:
  • method parameters which are annotated with Param and Header
  • methods which are annotated with Path or HTTP method annotations
  • classes which contain the methods above

  • Optional Element Summary

    Optional Elements 
    Modifier and Type Optional Element Description
    String value
    The description of a type, a field, a method or a parameter.

  • Element Details

    • value

      String value
      The description of a type, a field, a method or a parameter.
      Default:
      "\n\t\t\n\t\t\n\u0000\u0001\u0002\n\t\t\t\t\n"