com.toro.annotation

Annotation Type Documented

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

An annotation implicitly added to Groovy classes, fields, or methods with Javadoc.

This annotation is used to wrap Javadoc in order to re-use them in implicitly-added Swagger annotations so as to reduce redundancy when documenting APIs.

• Used on top of a class not already annotated with Api, this serves as an alias for Api wherein the value of value() will be plugged as Api.description().
• Used on top of a class not annotated with ApiModel but with XmlRootElement, this serves as an alias for the former wherein the value of value() will be plugged as ApiModel.description().
• Used on top of a method not annotated with ApiOperation, this serves as an alias for ApiOperation wherein the value of value() will be plugged as ApiOperation.notes().
• Used on top of a method which has parameters not annotated with ApiParam but with PathVariable, PathParam, QueryParam, RequestParam, or RequestBody, each non-ApiParam-annotated parameter will be implicitly annotated with one and will have the parameter Javadoc as the value of their respective ApiParam.value().
• Used on top of a method or field not already annotated with ApiModelProperty but with XmlElement, this serves as an alias for ApiModelProperty wherein the value of value() will be plugged as ApiModelProperty.value().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value

Element Detail

value

public abstract String value

Returns:

a string describing the Swagger resource, model, operation, response, or parameter

Default:

""