A JavaDoc viewer, editor and formatter.
This plugin was inspired by the same dialog in VisualSlickEdit which I missed a lot and by my desire to write some plugin for Idea 
WARNING 
- Shows and edits javadoc for classes, fields and methods in gui
- Automatically picks up parameters, return and exception info and merges it with existing javadoc if there is a conflict or mismatch
- Converts regular and line comments into javadoc
- Does not format text between <pre></pre> tags
- Generates see also tags for methods
- Formats javadocs using the following settings:
- (do not) align parameter comments to longest parameter name (min and max)
- (do not) align exception comments to longest exception name (min and max)
- (do not) add blank line after all @param tags
- (do not) add blank line after @return
- (do not) add blank line after all @throws tags
- (do not) add blank line after description
- (do not) add blank line after the whole javadoc
- keep/remove non-standard tags
- keep/remove empty lines
- (do not) add <p/> at empty lines
- generate @throws, not @exception
- (do not) generate @param with empty description
- (do not) generate @return with empty description
- (do not) generate @throws with empty description
- wraps text at specified column
- 1.0 Initial version
- 1.1 Added text wrapping (thanks to Erwin Tratar) and <pre> tag awareness.
- 1.2 Added generation of @see tags for methods
- 1.3 Added patterns for filtering methods (@see tag) and corresponding settings GUI
- 1.4 Updated to work with Aurora
By default it maps itself to F11. So unless you redefined this mapping just press F11 when you are on or near a method, a field or a class. The dialog will appear where you can view and edit javadoc.
You can navigate through all the fields using Tab and Shift-Tab. Pressing Tab (or Shift-Tab) in a parameter area will change it to the next (previous) parameter.
With Alt-D, Alt-I and Alt-S you can switch beetween Description, Info and Serial panels.
Using Alt-Up and Alt-Down you can change currently editing member or a class.
Pressing F2 saves all the changes and closes the dialog. Escape exits without applying the changes.
Pressing F1 will show a small help window with all these shortcuts.
TODO
- Implement "Serial" tags and panels
- Provide preview functionality (mostly depends on whether JetBrains guys open the corresponding API or not)
- Provide better editing (highlighting?, code completion?)
As usual just download the plugin jar file (see below) and place it in your IntelliJ/plugins directory, then restart Idea. Make sure you download the right version! There are basically two versions: one for Aurora (tested on build 816) and another for Ariadna.
-- DmitrySkavish - 23 May 2003
|
|
JavaDocEditorPlugin.jar 
JavaDocEditorPlugin-src.zip 