This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 206649 - Need to provide option to update Javadoc similar to Create Javadoc comment for a new declaration
Summary: Need to provide option to update Javadoc similar to Create Javadoc comment fo...
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 7.0.1
Hardware: All All
: P3 normal (vote)
Assignee: Jan Becicka
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-12-22 19:31 UTC by lvskiprof
Modified: 2012-09-26 13:03 UTC (History)
1 user (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description lvskiprof 2011-12-22 19:31:49 UTC
When I define a new method (or variable/object) I get an option to create the missing Javadoc comment block.  In the case of the method it will put in the tags for all the parameters, return type, etc.

What I would like to have handled is the case where multiple changes have been made to the method.  If I have changed more than one thing in the parameters, return type, or added/removed a throws I get individual items in the yellow light bulb suggestion list for each one.

The problem is that when you choose one it updates the comment according to what you chose and it leaves the focus on the added  or changed line.  This makes the yellow light bulb for the method go away, because it only shows up if the cursor in on that line (and it has to be on text in that line, not just anywhere in the line).

What would be better would be if an additional choice was offered that would just do all the suggested changes at once.  It would work very similar to creating a new one from scratch, but would delete unused items and add any new ones.  It can always be reversed via a Ctrl-Z if you don't like it, but it would greatly speed things up when updating multiple changes to a method.

As a side note, it would be nice if it didn't move the focus, at least if there are more changes remaining in the list when you choose only a single change.  Otherwise you are constantly having to click back somewhere on the method declaration line, wait for the yellow light bulb to appear, and selecting the next item from the list.

I wouldn't even mind if the yellow light bulb showed up permanently, just as it does for an unused import, for any line that is missing a Javadoc statement.  That might need to be a configurable option, since it is not the current behavior, but it would greatly aid in finding statements that have missing Javadoc comments.  It would be especially useful in large modules of outside code that you have to work on and wish to properly document with Javadoc as you do through it.  I am running into that issue with Selenium right now.
Comment 1 Milutin Kristofic 2012-09-26 13:03:46 UTC
We could have similar action in netbeans: http://blogs.jetbrains.com/idea/2012/09/fix-doc-comment-action-is-available/