Bug 41116 - [javadoc] javadoc fixup option
Summary: [javadoc] javadoc fixup option
Status: ASSIGNED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Text (show other bugs)
Version: 2.1   Edit
Hardware: PC Windows 2000
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-Text-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-08-04 18:34 EDT by James Manning CLA
Modified: 2003-08-23 09:31 EDT (History)
0 users

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 James Manning CLA 2003-08-04 18:34:20 EDT 
It would be nice if the methods in a class could have their javadoc updated to 
reflect added/changed/removed params, exceptions, return, etc.  It is easy for 
the javadoc to get desynced from reality and eclipse doesn't seem to have an 
easy way to help resync them
Comment 1 Dani Megert CLA 2003-08-22 10:36:53 EDT 
good idea - we actually talked about this last week.
Comment 2 James Manning CLA 2003-08-23 09:31:09 EDT 
One thing I've noticed is that Jalopy (http://jalopy.sf.net/) has some initial 
capabilities into this.  They're BSD-licensed and already have an Eclipse 
plugin (that seems to need updating, it didn't work under my 2.1 for opening 
the "Jalopy Preferences" window) but their command-line interface was great and 
had a ton of options for all kinds of fixup, javadoc included.

Course, whether that code is usable in the eclipse framework core is certainly 
another matter, just it looks nice that the code's out there, at least in some 
form :)