FlexDoc/Javadoc - Installation / Configuration Files
1. InstallationInstallation of FlexDoc/Javadoc is very simple:
- Unpack the downloaded archive.
Copy the FlexDoc license file
'flexdoc-javadoc.license', which you received by e-mail, into the
'lib'directory. This file must be always near the FlexDoc/Javadoc Java library (
designer.batto specify the
'JDK_HOME'variable according to the location of JDK 11 (or later) installed on your system.
generator.bat(e.g. to generate some demo JavaDoc)
designer.batto launch the Template Designer (e.g. to investigate JavadocClassic templates)
generator.batyour Java packages/classes to document.
- Documentation | FlexDoc Doclet | Running Doclet
- Documentation | FAQ | Troubleshooting | Cannot find doclet class
- The README file found in the downloaded archive
2. Configuration Files
This is the FlexDoc/Javadoc main configuration file.
The FlexDoc/Javadoc license file, which you should receive by e-mail.
The Template Designer configuration file.
It stores the designer configuration for the recently edited templates.
This file is created and maintained automatically.
The generator configuration file; used by the Generator
to obtain all settings not specified directly on the command line.
This file is created and maintained automatically by the generator dialog. It contains:
You can use the generator dialog to quickly prepare a config file with the specific settings you need and, then, provide only this file on the Javadoc command line (using -config option) instead of specifying all those settings directly.