Package ca.uhn.fhir.model.api.annotation

Annotation Interface Description

@Retention(RUNTIME) @Target({FIELD,TYPE,PARAMETER,METHOD}) public @interface Description
Annotation which may be placed on a resource/datatype definition, or a field, or a search parameter definition in order to provide documentation for that item.

  • Element Details

    • value

      String value
      A description of this method or parameter
      Since:
      5.4.0
      Default:
      ""

    • shortDefinition

      String shortDefinition
      Optional short name for this child
      Default:
      ""

    • formalDefinition

      @Deprecated String formalDefinition
      Deprecated.
      Use value() instead. Deprecated in 5.4.0.
      Optional formal definition for this child
      Default:
      ""

    • example

      String[] example
      May be used to supply example values for this
      Since:
      5.4.0
      Default:
      {}