Bug 264415

Description Wolfgang Knauf 2009-02-10 15:21:04 EST

Build ID: M20080911-1700

If JavaDoc validation is configured to "Malformed Javadoc comments" => "warning/error", then it complains about the following comment:

   * @param c
   *          Length of side c, > 0
   * @return Volume of the square stone = a * b * c
   * @exception InvalidParameterException
   *              If a or b or c <= 0.
The message is:
"Javadoc: Description expected after this reference"

Unfortunately, the default code formatter creates this stuff when "Source"=>"Format" (Ctrl+Shift+F) is called.

Workaround: create a custom code formatter profile and uncheck "Comments" => "Javadoc comment settings" => "New line after @param tags".

I don't know what the correct solution could be. I did not find anything in the JavaDoc documentation about linebreaks between the tag and the comment, so I don't know whether the warning/error is a false positive or correct.

Another solution would be to default the "New line after @param tags" with "unchecked". But this option does not make sense at all if the resulting javadoc is always considered malformed.