From the menubar, select File > Export. The Export dialog
opens.
Select "UML Documentation," and click "Next."
A new dialog opens:
NB: If the message "Javadoc command location not specified on the
Javadoc preference page" appears at the top of the dialog, exit the
wizard and configure your Javadoc preferences as follows. Navigate to Window
> Preferences. Expand "Java," and select "Javadoc."
On the right-hand side of the dialog, enter the location of your javadoc.exe
file. Typically, this in the bin directory of your sdk or jdk.
Select the project, packages, or diagrams for which you
want to generate documentation. Click on a package name to display its contents
to the right. You may generate docs for only one project at a time.
Select the type of output. "Directory" will place
documentation in a directory structure, the location of which you specify
in the "Destination" box below. "Jar file" will create
documentation in the jar file whose path and name you enter in the "Jar
file" box below. "E-mail" will send the results of the documentation
via email. To use the latter option, you must have specified an email server,
user, and password on the Documentation
preferences page.
NB: JDK 1.4 limitation: If you are using JDK 1.4, you will need to
specify a location other than the default. If not, the generated documentation
may not appear when opened in a browser.
Click "Next." A new dialog opens.
Select the options you want to include in documentation.
Click "Next." A new dialog opens.
Select the options desired. The document title will appear
on the overview page of your documentation. Select the visibility of members
to be included. If you select "Style sheet," you must specify
a path to the appropriate file.
Click "Next." A new dialog opens:
You may enter standard javadoc options, specifying path names where needed. If you select "Overview" or "Save the settings of this Javadoc export as an Ant Script," you must specify paths.
NB: Activating the Ant script option creates the Ant file that can be used to generate pure Javadoc documentation only. The Ant script will not produce full UML Documentation.
Click "Finish" to generate the documentation files in the
location you specified.
NB:
-
A warning dialog displays if the destination directory you specify is not empty.
-
If you entered a destination other than the default in step 5, a dialog opens asking whether or not you wish to make the new path the default for the current project.
-
If you chose "Directory" as your output, a dialog opens in which you may choose to display the results in a browser.
Once you have generated documentation for a project, you
can open it in a browser by selecting Navigate > Open UML Documentation:
