org.restdoc.annotations

Annotation Type RestDoc

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	id
String	methodDescription
String	resourceDescription

Element Detail

methodDescription

public abstract String methodDescription

Returns:

the description of the resource method

Default:

""

id

public abstract String id

Returns:

the id of the resource

Default:

""

resourceDescription

public abstract String resourceDescription

Returns:

the description of the resource

Default:

""