-
@Documented @Retention(SOURCE) @Target({FIELD,TYPE,MODULE,PACKAGE,PARAMETER,CONSTRUCTOR,ANNOTATION_TYPE,METHOD}) public @interface IncludeDescription
Denotes the AsciiDoc fragment to be imported into the generated REST-based microservice documentation.In addition to the description of all REST-based microservice documentation, this annotation also allows to developer to specify the AsciiDoc fragment for separate elements: sections, model fields, etc.
- Since:
- 0.1
- Author:
- nedis
- See Also:
Author,BaseEndpoint,DocumentationConstants,Description,DocumentationDefinition,DocumentationVersion,IncludeMode,IntroductionDefinition,License,ResourceDefinition,ResourceGroupDefinition,Title
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description IncludeModeincludeModeReturns the include mode.
-
-
-
Element Detail
-
resource
String resource
Returns the resource name.- Returns:
- the resource name
-
-
-
includeMode
IncludeMode includeMode
Returns the include mode. SeeIncludeModefor details.- Returns:
- the include mode.
- Default:
- io.rxmicro.documentation.IncludeMode.INCLUDE_REFERENCE
-
-