Module rxmicro.documentation
Package io.rxmicro.documentation
Annotation Type IntroductionDefinition
-
@Documented @Retention(SOURCE) @Target(ANNOTATION_TYPE) public @interface IntroductionDefinition
A composite annotation that specifies the settings for generating the Introduction section.- Since:
- 0.1
- Author:
- nedis
- See Also:
Author,BaseEndpoint,Constants,Description,DocumentationDefinition,DocumentationVersion,IncludeDescription,IncludeMode,License,ResourceDefinition,ResourceGroupDefinition,Title
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String[]customSectionReturns the custom sectionsIncludeModeincludeModeReturns the include mode.IntroductionDefinition.Section[]sectionOrderReturns the current section order
-
-
-
Element Detail
-
customSection
String[] customSection
Returns the custom sections- Returns:
- the custom sections
- Default:
- {}
-
-
-
includeMode
IncludeMode includeMode
Returns the include mode. SeeIncludeModefor details.- Returns:
- the include mode
- Default:
- io.rxmicro.documentation.IncludeMode.INCLUDE_REFERENCE
-
-
-
sectionOrder
IntroductionDefinition.Section[] sectionOrder
Returns the current section order- Returns:
- the current section order
- Default:
- {io.rxmicro.documentation.IntroductionDefinition.Section.COMMON_CONCEPT, io.rxmicro.documentation.IntroductionDefinition.Section.BASE_ENDPOINT, io.rxmicro.documentation.IntroductionDefinition.Section.HTTP_VERBS, io.rxmicro.documentation.IntroductionDefinition.Section.ERROR_MODEL, io.rxmicro.documentation.IntroductionDefinition.Section.HANDLER_NOT_FOUND, io.rxmicro.documentation.IntroductionDefinition.Section.LICENSES, io.rxmicro.documentation.IntroductionDefinition.Section.SPECIFICATION}
-
-