The following is an example of a @return
paragraph, which may be used in documentation comments for declarations of methods whose result type is not void
:
@return the number of widgets that pass the quality test
The information in a @return
paragraph has no special internal structure. The usual convention is that it consists of a short description of the returned value.
A documentation comment may contain at most one @return
tag.