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

Annotation Type 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.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	formalDefinition	Optional formal definition for this child
String	shortDefinition	Optional short name for this child

Element Detail

shortDefinition

String shortDefinition

Optional short name for this child

Default:

""

formalDefinition

String formalDefinition

Optional formal definition for this child

Default:

""