Bug 31100 - Add compiler option to catch param/javadoc discrepancies
Summary: Add compiler option to catch param/javadoc discrepancies
Status: RESOLVED WORKSFORME
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 2.1   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.0 RC4   Edit
Assignee: JDT-Core-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-02-06 11:30 EST by David Witherspoon CLA
Modified: 2005-04-07 09:04 EDT (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description David Witherspoon CLA 2003-02-06 11:30:53 EST 
It would be nice to have a compiler to option to warn me (or ignore, or error) when you see a parameter list that does not agree with (or for which there is missing) javadoc.  This is a feature in other products that I really miss in Eclipse.

I did a search and found a number of bugs complaining that rename (and the like) do not automatically adjust the javadoc.  If you catch it in the compiler, you'll catch all cases, whether the user changed a param using rename, or added it manually.  Plus, it'll catch all the other things...adding new parameters, removing parameters, adding/removing exceptions thrown, and so on.
Comment 1 Philipe Mulet CLA 2003-02-06 11:53:48 EST 
We have no plan in short term to be performing some javadoc checking (would be 
somewhat expensive and would need to first parse them).
Comment 2 Philipe Mulet CLA 2003-10-30 04:37:48 EST 
support got added in 3.0 stream
Comment 3 Philipe Mulet CLA 2005-04-07 09:03:59 EDT 
should have been closed properly
Comment 4 Philipe Mulet CLA 2005-04-07 09:04:43 EDT 
support added in 3.0