The documentation generation can be launched from the pop-up menu or from the menu bar after selecting a java element in the package explorer. The generated documentation will be dedicated either to this java element or to the whole java project. A wizard dialog appears.
On the first step of the wizard, you can choose either to work on
your selection or to work on the whole project.
On the second step of the wizard, you must select the directory
where the documentation will be generated.
It can be either an existing folder or a new one or a linked one.
On the third step of the wizard, you can edit the title and date of
the documentation. Author and authoring (legal notice, licence, ...)
information can be added
On the last step of the wizard, you must select a template for the documentation generation.
Each template define which kind of element will be inserted in the
generated documentation and how it will be formated.
So it you selected a single class, you won't have any template proposed
by default and will have to define one by yourself.
The documentation is generated through several steps :
If any error is found in the javadoc, it is fixed in the generated
documentation. For example, malformed tag-embedments are skipped and
unclosed tags are closed. < and > characters which are not tag
delimiters are changed to numeric entities.
The processed modifications are listed at the end of the generation. Original
source files are not modified.
Here is a sample of a generated documentation :
