3.2 Supported standard JavaDoc tags

The following standard JavaDoc tags are supported on resource methods:

Table 3.1. Standard JavaDoc tags
Tag Function
@param {name} {doc} This is used to document the corresponding resource method parameters annotated with @PathParam, @QueryParam or @MatrixParam. Can be used at most once per parameter name.
@return {doc} Documents the entity returned from this resource method. Can only be used once.