Bug 108758 - Add javadoc should add TODO tags
Summary: Add javadoc should add TODO tags
Status: CLOSED WONTFIX
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 73352
Blocks:
  Show dependency tree
 
Reported: 2005-09-04 09:00 EDT by Koen van Dijken CLA
Modified: 2009-08-30 02:13 EDT (History)
4 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 Koen van Dijken CLA 2005-09-04 09:00:24 EDT 
When javadoc is added to a method, TODO tags should be inserted at appropriate
places. Note that when I use Refactor / Change Method Signature to add a
parameter to an existing method which allready has javadoc, the new parameter is
added to the javadoc. This new parameter in the javadoc *does* get a TODO tag.
This difference is inconsistent behaviour.

Eclipse 3.2M1
Comment 1 Koen van Dijken CLA 2005-09-04 09:10:54 EDT 
I do not know the internal mechanism which adds javadoc to methods, but Refactor
/ Extract Method does *not* add a TODO tag, this in contrast to Refactor /
Change method signature. These actions should all behave the same when adding
javadoc.
Comment 2 Dani Megert CLA 2005-09-05 04:41:38 EDT 
You could add the todo tag to the new method comment code template.
Comment 3 Dirk Baeumer CLA 2005-09-05 13:20:05 EDT 
What we want to avoid is the fact that TODO tags get scattered all over the
place. So we only generate them when we modify code out of the scope of the
current action (for example change method signature can be invoked on the
calling side of the method and the actual declaration isn't visible in the
editor. This is not the case for Add Javadoc comment or extract method.

Now that we have Javadoc warnings I am more in favour of having a warning for a
missing description that generating TODO tags. I opened a corresponding PR
against JDT/Core.

Waiting for comments on bug 108798.
Comment 4 Johan Walles CLA 2007-03-01 07:09:43 EST 
As Dirk Baeumer said, warning about empty javadoc tags (bug 73352) should be the proper way of doing this.

Koen, what do you think about this now that you have received some feedback about it?
Comment 5 Koen van Dijken CLA 2007-03-06 03:52:45 EST 
Generating a warning seems fine to me.
Comment 6 Johan Walles CLA 2007-03-06 03:59:31 EST 
Cool!  Would it be possible for you to close this bug in that case, since bug 73352 contains the more widely agreed upon solution?

I would have done it myself if I had the permissions to do so...
Comment 7 Koen van Dijken CLA 2007-03-06 04:05:09 EST 
Bug closed in favor of https://bugs.eclipse.org/bugs/show_bug.cgi?id=73352
Comment 8 Denis Roy CLA 2009-08-30 02:13:55 EDT 
As of now 'LATER' and 'REMIND' resolutions are no longer supported.
Please reopen this bug if it is still valid for you.