-
@Documented @Retention(SOURCE) @Target({FIELD,TYPE,MODULE,PACKAGE,PARAMETER,CONSTRUCTOR,ANNOTATION_TYPE,METHOD}) public @interface Description
Denotes the description of the generated REST-based microservice documentation.(Allows overriding the description specified in the description directive to pom.xml)
In addition to the description of all REST-based microservice documentation, this annotation also allows to developer to specify a description of separate elements: sections, model fields, etc.
- Since:
- 0.1
- Author:
- nedis
- See Also:
Author,BaseEndpoint,DocumentationConstants,Description,DocumentationDefinition,DocumentationVersion,Example,IncludeDescription,IncludeMode,IntroductionDefinition,License,ResourceDefinition,ResourceGroupDefinition,Title
-
-
Element Detail
-
value
String value
Returns the description.- Returns:
- the description
-
-