FlexDoc/Javadoc - Overview
- What is FlexDoc/Javadoc?
- Key Features
- Technical Requirements
- Functional Entities
- Full Licenses
- How It Works
- Doclet API as virtual XML document
- Insertion of images
- Output formats
- Doclet GUI
- Ready template applications
Javadoc is not a separate software but rather a part of the whole Java Development Kit (JDK),
which you can freely download from the Oracle Corporation website by this link:
Specifically, the FlexDoc/Javadoc software available for downloads includes
- Windows batch files
- macOS and Linux shell script files
Additionally, a sample Ant buildfile and Maven POM file are provided to demonstrate integration of FlexDoc Doclet both with Apache Ant and Maven. For more details, please see FlexDoc/Javadoc | Documentation | Integrations.download as a single archive. It includes everything (all features available in this product line): licenses to use those features you need (if they are not free). FlexDoc/Javadoc is very complex software that took many years to develop. So, we break the whole FlexDoc/Javadoc into a number of logical products (or functional entities) according to the major functionality implemented. Some of those products are free, others require separate licensing.
Below is the list of such products along with the details of how they are licensed.Template Designer both visualizes the template language and gives you access to most of FlexDoc.XYZ features.
Template Designer is covered by the “FlexDoc/Javadoc” license, depending on which it may work in one of two modes:
|Feature / Functionality||Demo Mode||Full Mode|
|License type(s)||Demo License (activated by default)||Trial or Full License for FlexDoc/Javadoc|
|Possibility to create/modify templates||No. You can investigate any GUI functionality but not save any created/modified templates.||Template Designer will work without limitations. You can create/modify any templates.|
This includes:generator”) is provided by FlexDoc/Javadoc Java library.
|Feature / Functionality||Default Mode||Extended Mode||Trial Mode|
(activated by default)
|Full License for FlexDoc/Javadoc||Trial License for FlexDoc/Javadoc|
|Execution of any custom templates.||only those created or modified the last time under a Full License for FlexDoc/Javadoc||distorted output|
Execution of templates provides by Filigris Works.
This depends also on your license for that particular template application (see Licensing of Templates).
|No limitation on input Java project (number of classes etc.)|
|Generation of HTML, RTF, TXT (plain text) output|
|Custom CSS in HTML output.||only templates created or modified the last time under a Full License for FlexDoc/Javadoc|
|Any number of output files of any size|
|Possible usage of generated documentation.||any usage||unlimited||for evaluation only|
Implements a very powerful Java API Documentation Generator able to produce both multi-framed Javadoc-like
HTML and printable RTF documentation.
|demo, Trial or Full License for FlexDoc/Javadoc|
Allows you to run FlexDoc Doclet from your Ant build.
For more details, please see: FlexDoc/Javadoc | Documentation | Integrations | Apache Ant
|settings in your Ant build file||free|
Allows you to run FlexDoc Doclet from your Maven build.
For more details, please see: FlexDoc/Javadoc | Documentation | Integrations | Apache Maven
|settings in your Maven POM file||free|
|FlexDoc/Javadoc||Covers everything currently implemented:|
In the future more, ready template applications are coming (e.g. Javadoc9), which may be covered by separate licenses.See Also: