JDocHelper Home Page
Current Version: 0.8.2
Last Modified: 2001/05/31
JDocHelper is a tool to help add Javadoc comments to java source files.
This tool can insert Javadoc comment template to each classes, methods and variables.
Moreover JDocHelper can parse Java source files to insert more detailed information
like param tags with argument names and exception tags with the names of exception classes.
This tool has GUI that can show you HTML pages that you are describing as Javadoc comments.
All methods, variables and inner classes defined in java source files are displayed
in the window with source code, so this tool can be used as source code browser.
It can display classes, methods and variables' definitions with tree structure.
- Powerful GUI.
- Insert Javadoc comments automatically.
- Parse source files and insert author, param and exception tags.
- Insert file header on top of source file.
- Check whether Javadoc comments are appropriate or not.
- Display contents of source file with tree view.
- Edit Javadoc tags in the table.
- Show HTML page that you are describing as Javadoc comment.
- Show source code that are describing Javadoc comment.
- Manage some source files in a project.
- Select access modifiers to display in tree view.
- Browse java classes.
JDocHelper is the open source software that is released under the
GPL(GNU General Public License). You can download binary files and source files
from below sites. You can download old versions from
SourceForge JDocHelper Project.
All you have to do is to create a new directory and to extract files to that directory.
JDocHelper needs Java runtime environments. If you don't have one, you have to download and setup it.
JDocHelper runs on next environments.
- JDK1.1 + Swing1.1.1
Change the current directory to installation directory(extract directory)
and run bat file in that directory. Or type next command.
JDocHelper will make ".jdh" directory in your home directory when started. Settings are saved in ".jdh" directory.
- JDK1.2 or JDK1.3
> java -jar JDocHelper.jar
- JDK1.1 + Swing1.1.1
> java -classpath %CLASSPATH%;JDocHelper.jar
> java -classpath $CLASSPATH:JDocHelper.jar
NOTICE: CLASSPATH must contain Swing jar file(swingall.jar).
If you want to uninstall, delete extract directory and ".jdh" directory in you home directory. That's all.
- Check source files are compiled without error.
JDocHelper cannot parse source files that have error in javac compilation.
You must check it before you add source files to JDocHelper.
- Start JDocHelper and add files.
Click the menu [File]-[Add] in JDocHelper to load a source file that you want edit.
On default setting, a source file is parsed when it is loaded.
And param and exception tags are inserted automatically.
If those are already described in your source file, tags are not added.
- Refer methods and variables that you want to edit.
Click a method node or a variable node in tree view,
then right pane responds to display Javadoc comments and tags in comments.
The upper part displays Javadoc comments and the lower part displays
all tags that are described in Javadoc comments in table.
Icons in tree view indicates each node's access modifiers.
At default setting, only public or protected nodes are displayed.
Click [Option]-[Change Settings] on menu and select private,
private methods and variables are displayed.
- Edit Javadoc comments.
Edit any Javadoc comments and tags that you want.
Editing doesn't affect original source file but is hold in tool data.
Edited methods or variables are displayed as bold.
- Reflect changes to source file.
After you finish editing Javadoc comments, you can reflect it
to source file by clicking [File]-[Save] on menu.
On default setting, a new file whose name is original name plus ".jdh" is created.
If you want to overwrite an original source file, you can by optional setting.
Documents that don't have links are not released or finished. Those will be released soon.
I'm pleased to receive your requests and comments about JDocHelper.
Please send me an e-mail.
Copyright (C) 2001
Last modified: 2001/05/31