Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 44994

Summary: Please provide automated management of JavaDoc
Product: [Eclipse Project] JDT Reporter: Luke Evans <luke.evans>
Component: UIAssignee: JDT-UI-Inbox <jdt-ui-inbox>
Status: RESOLVED WONTFIX QA Contact:
Severity: enhancement    
Priority: P3 Keywords: helpwanted
Version: 3.0   
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:

Description Luke Evans CLA 2003-10-16 03:52:12 EDT 
Other products provide features to manage JavaDoc once is has been created.  Thus, modifying the 
code causes the IDE to try to keep the JavaDoc up-to-date (at least in sync) with the code.  Eclipse 
currently allows 'one time' creation of JavaDoc headers, but no assistance in keeping it up-to-date 
after creation.

At the very least, it would be nice to optionally have an indicator (possibly in the gutter) indicating 
where JavaDoc is out-of-sync, and offering (through a quick-fix) to sync the comment.  Even if the 
latter is not provided, early indication of JavaDoc problems would be very valuable as otherwise 
these are often only spotted as part of the build process (disjoint from the changes that cause 
divergence from the code).
Comment 1 Martin Aeschlimann CLA 2003-10-16 04:21:29 EDT 
Sure I agree that is nice to have, but there are currently no plans for this.
This is why:

Javadoc is created using the Javadoc command for a user specified JRE.
Unfortunaltly, the current versions of Javadoc don't support an incremental
mode. Applied on only a subset of files, you will end up with a differenet 'All
types' link page, for example.
So going in the incremental business would either require to implement an own
javadoc generating tool (won't happen) or to play tricks on how to use the
Javadoc command: Note that different JRE have different command, create
different html and mapping from elements to html is a heuristic.
I think we run into more troubles than what we really win from having it.

To detect errors in Javadoc tags (in the editor) is on the plan for 3.0