Bug 175992 - [javadoc] Provide Compiler Warnings for empty @param and @exception JavaDoc tags
Summary: [javadoc] Provide Compiler Warnings for empty @param and @exception JavaDoc ...
Status: VERIFIED DUPLICATE of bug 73352
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 M3   Edit
Assignee: JDT-Core-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-03-01 05:20 EST by Ulli Hafner CLA
Modified: 2007-10-29 07:34 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ulli Hafner CLA 2007-03-01 05:20:05 EST
It would be nice, if the JavaDoc checker could be more rigid (maybe an option in the settings Java Compiler->JavaDoc). Currently. the compiler checks only for @return and @see tags if there is a valid description provided (Missing description warning). However, for @param and @throws tags, the compiler checks only for the presence of the tags and not if there is a valid content (description) provided.

Example:

	/**
	 * Changes the Password of the specified user.
	 * 
	 * @param user
	 * @param password
	 * @throws SQLException
	 * @see
	 * @return
	 */
	public boolean changePassword(String user, String password) throws SQLException;

The compiler now shows a warning for the missing description in the @see and @return tags, but not in the @param and @throws tags. It would be nice if you could add this enhancement, since these empty tags are almost useless.
Comment 1 Frederic Fusier CLA 2007-03-01 05:53:24 EST

*** This bug has been marked as a duplicate of bug 73352 ***
Comment 2 David Audel CLA 2007-10-29 07:34:15 EDT
Verified for 3.4M3 using I20071029-0010 build.