Bug 48003

Summary:	[clean up] Cleanup Javadoc comments
Product:	[Eclipse Project] JDT	Reporter:	Nikolay Metchev <nikolaymetchev>
Component:	UI	Assignee:	JDT-UI-Inbox <jdt-ui-inbox>
Status:	ASSIGNED ---	QA Contact:
Severity:	enhancement
Priority:	P3	CC:	b.muskalla, benno.baumgartner, thomas.p.dickens
Version:	3.0
Target Milestone:	---
Hardware:	All
OS:	All
Whiteboard:

Description Nikolay Metchev

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

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

2007-06-25 04:43:42 EDT

*** Bug 58699 has been marked as a duplicate of this bug. ***

Comment 3 Benno Baumgartner

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

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

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