Module rxmicro.documentation

Package io.rxmicro.documentation

Annotation Type Example

@Documented
@Retention(SOURCE)
@Target({FIELD,METHOD,PARAMETER})
@Repeatable(List.class)
public @interface Example

Denotes the model field value used as an example in the generated REST-based microservice documentation.

Since:

0.1

Author:

nedis

See Also:

Description, IncludeDescription, IncludeMode

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	Returns the example value

Element Detail

value

String value

Returns the example value

Returns:

the example value