com.webcohesion.enunciate.metadata

Annotation Type DocumentationExample

@Target(value={TYPE,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface DocumentationExample

Used to mark a method as an example method to be used in the generated documentation.

Author:

Ryan Heaton

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	exclude Whether to exclude this example.
TypeHint	type The type to use for documentation purposes, useful (for example) when a specific subclass is desired in the documentation example.
String	value The value of this documentation example.
String	value2 A second value for this documentation example to be used e.g.

Element Detail

exclude

public abstract boolean exclude

Whether to exclude this example.

Returns:

Whether to exclude this example.

Default:

false

value

public abstract String value

The value of this documentation example.

Returns:

The value of this documentation example.

Default:

"##default"

value2

public abstract String value2

A second value for this documentation example to be used e.g. for arrays.

Returns:

A second value for this documentation example to be used e.g. for arrays.

Default:

"##default"

type

public abstract TypeHint type

The type to use for documentation purposes, useful (for example) when a specific subclass is desired in the documentation example.

Returns:

The type to use for documentation purposes, useful (for example) when a specific subclass is desired in the documentation example.

Default:

@com.webcohesion.enunciate.metadata.rs.TypeHint