Bug 48003 - [clean up] Cleanup Javadoc comments
Summary: [clean up] Cleanup Javadoc comments
Status: ASSIGNED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.0   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 58699 (view as bug list)
Depends on:
Blocks:
 
Reported: 2003-12-03 12:23 EST by Nikolay Metchev CLA
Modified: 2008-11-04 14:02 EST (History)
3 users (show)

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 Nikolay Metchev CLA 2003-12-03 12:23:28 EST 
It would be nice to be able to remove unused @param values in the javadoc and 
to add any missing @param values in public methods using the new formatter! The 
comment for the missing @params should be configurable so that I can say that 
it should generate 
@param x TODO: Comment ME!
for example!
Comment 1 Dirk Baeumer CLA 2003-12-03 13:08:33 EST 
This isn't something that a formatter should do. A formatter doesn't fix 
errors as well ;-).
Comment 2 Benno Baumgartner CLA 2007-06-25 04:43:42 EDT 
*** Bug 58699 has been marked as a duplicate of this bug. ***
Comment 3 Benno Baumgartner CLA 2007-06-25 04:57:24 EDT 
Also 'Generate element comments' clean up option

--- Javadoc ------------------------------------
[ ] Add element comments            Configure... (link to template p page)
  [ ] Types [ ] Files
  [ ] Methods [ ] Constructors [ ] Fields

[ ] Add missing javadoc tags        Configure... (Bug 194170)
  [ ] @param [ ] @return [ ] @throws

[ ] Remove unnecessary javadoc tags
------------------------------------------------
Comment 4 Benno Baumgartner CLA 2008-07-16 05:57:40 EDT 
I think only the following clean ups would be useful:
- Remove unnecessary javadoc tags
- Add (replace?) File comments (add copyright header)
- Add (replace?) Type comments (add @since tag)

Replacing missing comments with a dummy comment is certainly nothing we should provide.
Comment 5 Benjamin Muskalla CLA 2008-11-04 14:02:09 EST 
> - Add (replace?) Type comments (add @since tag)
would be nice to see this in conjunction with bug 246067: [code templates] provide a since tag argument resolver