Module rxmicro.documentation

Package io.rxmicro.documentation

Annotation Type DocumentationDefinition

@Documented
@Retention(SOURCE)
@Target({MODULE,ANNOTATION_TYPE})
public @interface DocumentationDefinition

A composite annotation that specifies the settings for generating a whole document.

Since:

0.1

Author:

nedis

See Also:

Author, BaseEndpoint, DocumentationConstants, Description, DocumentationVersion, IncludeDescription, IncludeMode, IntroductionDefinition, License, ResourceDefinition, ResourceGroupDefinition, Title

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	destinationDirectory	Returns the custom destination directory.
IntroductionDefinition	introduction	Returns the composite annotation that specifies the settings for generating the Introduction section.
DocumentationDefinition.GenerationOutput[]	output	Returns the array of outputs.
ResourceDefinition	resource	Returns the composite annotation that specifies the settings for generating the ResourceDefinition section.
ResourceGroupDefinition	resourceGroup	Returns the composite annotation that specifies the settings for generating the ResourceGroupDefinition section.
boolean	withGeneratedDate	Returns true if the RxMicro framework must generate date of generating of REST-based microservice documentation.
boolean	withTips	Returns true if the RxMicro framework must generate tips for REST-based microservice documentation.

Element Detail

output

DocumentationDefinition.GenerationOutput[] output

Returns the array of outputs. See DocumentationDefinition.GenerationOutput for details.

Returns:

the array of outputs. See DocumentationDefinition.GenerationOutput for details.

Default:

{io.rxmicro.documentation.DocumentationDefinition.GenerationOutput.SINGLE_DOCUMENT}

destinationDirectory

String destinationDirectory

Returns the custom destination directory.

Returns:

the custom destination directory

Default:

""

withTips

boolean withTips

Returns true if the RxMicro framework must generate tips for REST-based microservice documentation.

Returns:

true if the RxMicro framework must generate tips for REST-based microservice documentation

Default:

true

withGeneratedDate

boolean withGeneratedDate

Returns true if the RxMicro framework must generate date of generating of REST-based microservice documentation.

Returns:

true if the RxMicro framework must generate date of generating of REST-based microservice documentation

Default:

true

introduction

IntroductionDefinition introduction

Returns the composite annotation that specifies the settings for generating the Introduction section.

Returns:

the composite annotation that specifies the settings for generating the Introduction section.

Default:

@io.rxmicro.documentation.IntroductionDefinition

resourceGroup

ResourceGroupDefinition resourceGroup

Returns the composite annotation that specifies the settings for generating the ResourceGroupDefinition section.

Returns:

the composite annotation that specifies the settings for generating the ResourceGroupDefinition section.

Default:

@io.rxmicro.documentation.ResourceGroupDefinition

resource

ResourceDefinition resource

Returns the composite annotation that specifies the settings for generating the ResourceDefinition section.

Returns:

the composite annotation that specifies the settings for generating the ResourceDefinition section.

Default:

@io.rxmicro.documentation.ResourceDefinition