The following specific JavaDoc tags are supported on resource methods:
| Tag | Function |
|---|---|
@HTTP {code} {doc} |
This is used to document the codes that the method can return. Can be used multiple times. |
@inputWrapped {fq-classname} |
Specifies the real type of input when declared as a String parameter.
Can only be used once. |
@returnWrapped {fq-classname} {doc} |
Used in place of @return when output type is String, void
or Response to specify the real type of output and documentation for each possible type.
Can be used multiple times. |
@RequestHeader {header} {doc} |
This is used to document HTTP request headers. Can be used multiple times. |
@ResponseHeader {header} {doc} |
This is used to document HTTP response headers. Can be used multiple times. |