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 89603 - Javadoc fixes/Autocomment replacement
Summary: Javadoc fixes/Autocomment replacement
Status: RESOLVED FIXED
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 6.x
Hardware: All All
: P2 blocker with 2 votes (vote)
Assignee: Jan Pokorsky
URL:
Keywords: UI, UMBRELLA
: 82237 158630 (view as bug list)
Depends on: 95398 95463 96250
Blocks:
  Show dependency tree
 
Reported: 2006-11-19 12:53 UTC by Petr Hrebejk
Modified: 2009-02-17 12:45 UTC (History)
3 users (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 Petr Hrebejk 2006-11-19 12:53:39 UTC
Automatically generate/fix/watch Javadoc errors.
Comment 1 Jan Pokorsky 2006-12-19 14:29:24 UTC
*** Issue 82237 has been marked as a duplicate of this issue. ***
Comment 2 Jesse Glick 2007-02-12 20:07:04 UTC
Sounds cool; out of curiosity, is there a UI spec or wiki summary or anything
like that?
Comment 3 Jan Pokorsky 2007-02-13 15:05:51 UTC
There is none AFAIK. As stated in summary field it is simply replacement of the
Autocomment tool.

I can summarize it here:

Javadoc fixes are intended to scan a source file for missing or corrupted
javadoc of class members and to offer editor hints to create missing javadoc or
to fix the corrupted javadoc. In order to preserve performance and not clutter
the editor stripe, just members with public and protected access are covered.
Later when there will be options for editor hints we could permit users to
customize the scope.

What is checked:
 - missing javadoc
 - @param tags if duplicate, missing, unknown
   - @param may stand for method/constructor parameter or class type parameter
   - jdk 5 and 6 implementation of javadoc ignores method type parameters
 - @throws/exception tags if duplicate, missing, unknown
 - @return tags if duplicate, missing, void
 - @deprecated tag if duplicate, missing (in case of @Deprecated annotation)
 - @inherited - explicit inheritance
 - implicit inheritance - check for super class javadoc
   - javadoc and its parts may be inherited

In case there are more then one missing javadoc then the Fix All Missing Javadoc
hint is offered together with each particular Create Missing Javadoc hint.

What is out of the scope of this task:
 - javadoc completion
 - import fixes
 - usage highlighting

What would be nice:
 - offer a Correct Javadoc hint in case of several javadoc hints on one class
member exist
 - generate javadoc on /** + Enter (issue #77039)

I have integrated the Javadoc fixes yesterday so you can try them. Since the
retouche still does not support javadoc modifications (#issue 90302) I had to
work around this and some cases like field groups are not supported yet (#issue
95359).
Comment 4 Jesse Glick 2007-02-13 19:15:48 UTC
Cool, I will file issues blocking this as needed.

BTW:

Warning: in org.netbeans.modules.javadoc, not using spec.version.base, yet
declaring implementation dependencies; may lead to problems with Auto Update
(see http://wiki.netbeans.org/wiki/view/DevFaqImplementationDependency)
Comment 5 Jesse Glick 2007-02-13 20:17:53 UTC
I guess if "Javadoc completion" and "import fixes" are out of scope, then so is
noting bad Javadoc links, e.g.

@see Objct#notify
Comment 6 Jan Pokorsky 2007-02-13 23:59:14 UTC
FYI, I have added several options to limit number of hints as complaints against
the yellow editor have been rising :-) For more details see issue #95398.

Re Javadoc links
Yes, no links are checked now. But I would like to add it to nb 6.0. Likely it
has to go to the java/hints module to be consistent with import hints.

Re dependencies
fixed in
/cvs/javadoc/manifest.mf
new revision: 1.74; previous revision: 1.73
/cvs/javadoc/nbproject/project.properties
new revision: 1.8; previous revision: 1.7
Comment 7 deeptinker 2007-05-10 03:44:52 UTC
Note that the help docs with 60 M9 still refer to the Autocomment Tool and how
to bring it up.  Should that be a new issue that blocks this one, or can that be
changed under this issue?
Comment 8 Jan Pokorsky 2007-05-10 10:55:20 UTC
Help documentation is being reviewed before final release usually.

to pkeegan: Patrick is it necessary to file an issue for this?
Comment 9 Patrick Keegan 2007-05-10 13:35:38 UTC
Not totally necessary, particularly if it's covered in a visible place, such as
the New & Noteworthy pages.....
Comment 10 tomzi 2007-08-01 15:52:17 UTC
Should this already work in Build 200707240000, because it doesn't?
Comment 11 Jan Pokorsky 2007-08-01 16:04:14 UTC
javadoc hints are disabled by default. See Tools/Options/Java Code/Hints.
Comment 12 Jiri Prox 2009-02-17 12:45:20 UTC
*** Issue 158630 has been marked as a duplicate of this issue. ***