When the @param tag in a doc comment has a variable but no textual description,
nothing pertaining to the parameter shows up in the html file, but the user
is not given a warning. For example, if the following appeared in a doc comment,
@param x
no warning would be given to the user, yet nothing pertaining the parameter x
would appear in the html file.
The @exception tag will give the user a warning in similar sitations in which
it has no text. For example, the tag
@exception GenericException
will give the user a warning that there's no text accompanying the @exception
tag.
A similar warning for the @param tag would be useful.
nothing pertaining to the parameter shows up in the html file, but the user
is not given a warning. For example, if the following appeared in a doc comment,
@param x
no warning would be given to the user, yet nothing pertaining the parameter x
would appear in the html file.
The @exception tag will give the user a warning in similar sitations in which
it has no text. For example, the tag
@exception GenericException
will give the user a warning that there's no text accompanying the @exception
tag.
A similar warning for the @param tag would be useful.