Package io.contextmap.annotations

Annotation Type ContextApiProperty

@Target({FIELD,METHOD})
@Retention(RUNTIME)
public @interface ContextApiProperty

Annotation used to customize the documentation of a property.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	dataType	Can be used to override the class' simple-name documentation for a property.
String	description
String	example	Only Enums are automatically documented with an example, which contains the potential values of the Enum.

Element Detail

dataType

String dataType

Can be used to override the class' simple-name documentation for a property.

Returns:

the name of the data type of the property

Default:

""

description

String description

Returns:

the description for a property

Default:

""

example

String example

Only Enums are automatically documented with an example, which contains the potential values of the Enum.

Returns:

an example for a property

Default:

""