Kbase 21351: How To Use Javadoc Tool to Generate Javadoc for Packages
| Autor |
Progress Software Corporation - Progress |
| Acesso |
Público |
| Publicação |
08/02/2005 |
|
Status: Unverified
GOAL:
How to use the Javadoc tool to generate required Java documentation.
FACT(s) (Environment):
Windows NT 32 Intel/Windows 2000
FACT(s) (Environment):
Windows 32 Intel
FACT(s) (Environment):
Progress 9.1x
FIX:
Here is an example of how to generate Javadoc for the package, com.progress.sql.jdbc.
1) Unzip %DLC%\java\jdbc.zip to a directory, say c:\temp.
Having done that, the following directory structure will be present,
c:\temp\com\progress\sql\jdbc
All the related .class files are in this directory.
2) After installing JDK, make sure %JDKHOME%\bin is in the PATH.
If a development type Progress license is installed, make sure %dlc%\jdk\bin is in the PATH.
3) cd to the parent directory of the fully-qualified package.
For example, c:\temp\com\progress\sql\.
4) Run the following command:
javadoc -d c:\temp jdbc
This will create a javadoc directory under c:\temp.
5) cd to this directory then open index.html in a browser. The standard Javadoc format will be displayed.
By clicking on the corresponding links class documentation will be displayed.