Package com.toro.annotation

Annotation Interface Documented

@Target({METHOD,TYPE,FIELD,CONSTRUCTOR,ANNOTATION_TYPE})
@Retention(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
  invalid reference

  Api

  , this serves as an alias for Api wherein the value of value() will be plugged as
  invalid reference

  Api#description()

  .
• Used on top of a class not annotated with
  invalid reference

  ApiModel

  but with
  invalid reference

  XmlRootElement

  , this serves as an alias for the former wherein the value of value() will be plugged as
  invalid reference

  ApiModel#description()

  .
• Used on top of a method not annotated with
  invalid reference

  ApiOperation

  , this serves as an alias for ApiOperation wherein the value of value() will be plugged as
  invalid reference

  ApiOperation#notes()

  .
• Used on top of a method which has parameters not annotated with
  invalid reference

  ApiParam

  but with PathVariable, PathParam, QueryParam, RequestParam, or RequestBody, each non-
  invalid reference

  ApiParam

  -annotated parameter will be implicitly annotated with one and will have the parameter Javadoc as the value of their respective
  invalid reference

  ApiParam#value()

  .
• Used on top of a method or field not already annotated with
  invalid reference

  ApiModelProperty

  but with
  invalid reference

  XmlElement

  , this serves as an alias for ApiModelProperty wherein the value of value() will be plugged as
  invalid reference

  ApiModelProperty#value()

  .

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	value

Element Details

value

String value

Returns:

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

Default:

""