org.codehaus.enunciate.doc
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
 boolean exclude
          Whether to exclude this example.
 ExampleType[] validTypes
          Valid types for documentation examples.
 java.lang.String value
          The value of this documentation example.
 

exclude

public abstract boolean exclude
Whether to exclude this example.

Returns:
Whether to exclude this example.
Default:
false

value

public abstract java.lang.String value
The value of this documentation example. Applicable to JAXB fields and properties.

Returns:
The value of this documentation example. Applicable to JAXB fields and properties.
Default:
"##default"

validTypes

public abstract ExampleType[] validTypes
Valid types for documentation examples. E.g. use to declare that a certain type is only valid in its JSON form.

Returns:
The valid types for the documentation example.
Default:
{org.codehaus.enunciate.doc.ExampleType.XML, org.codehaus.enunciate.doc.ExampleType.JSON}