FlexDoc/Javadoc, Version 2.0

Release Notes

Table Of Contents

Package Contents

File / Directory Description
LICENSE.html FlexDoc Software License
README.html this file
CHANGES.html change log of FlexDoc/Javadoc
docs/ FlexDoc/Javadoc & FlexDoc.XYZ Documentation – an HTML copy of all descriptions/documentation published on the product web-site (on the moment of the release). It may be useful when you cannot access the online pages or they changed too much since this release.
bin/ Files prepared for Windows Installation:
   designer.bat
   generator-modular.bat
   generator-modular_azure.bat
   generator-modular_RTF.bat
  • the same for single-file RTF
   generator-non-modular.bat
bin/linux/ Files prepared for Linux Installation:
   designer.sh
  • shell script file to launch Template Designer
   generator-modular.sh
  • shell script to run Javadoc + FlexDoc Doclet to document a multi-modular demo Java project
   generator-modular_azure.sh
  • the same prepared to generate framed HTML with an alternative CSS skin
   generator-modular_RTF.sh
  • the same for single-file RTF
   generator-non-modular.sh
bin/macOS/ Files prepared for macOS Installation:
   designer.command
  • shell script file to launch Template Designer
   generator-modular.command
  • shell script to run Javadoc + FlexDoc Doclet to document a multi-modular demo Java project
   generator-modular_azure.command
  • the same prepared to generate framed HTML with an alternative CSS skin
   generator-modular_RTF.command
  • the same for single-file RTF
   generator-non-modular.command
lib/ Runtime Environment:
   flexdoc-javadoc.jar
  • FlexDoc/Javadoc Java library
   flexdoc.config
  • FlexDoc main config file prepared for Windows. This file contains locations of other config files and various important settings.
   flexdoc_linux.config
  • the main config file prepared for Linux
   flexdoc_macOS.config
  • the main config file prepared for macOS
config/ Configuration files (created and updated dynamically):
   designer.config
   generator.config
   generator_azure.config
  • the same for framed HTML with an alternative CSS skin
   generator_RTF.config
  • the same for single-file RTF
templates/ Bundled template applications
   classic/
demo/ Java files for demo generation:
   modular/
  • multi-modular demo Java project
   non-modular/
  • non-modular demo Java project
   taglets/
  • contains the compiled demo taglet class used in demo documentation generation, whose Java source is either
    • modular/misc/taglets/OracleLinkTaglet.java
    • non-modular/taglets/OracleLinkTaglet.java
   make_taglet.(bat|sh|command)
  • Windows / Linux / macOS command files to compile the demo taglet
integrations/ The support files for integrations of FlexDoc/Javadoc with other software systems
   ant/
  • Ant example files:
      modular/
  • Modular project:
         build.xml
  • A simple ANT buildfile to demonstrate integration of FlexDoc Doclet with Apache Ant
         make.(bat|sh|command)
  • Windows / Linux / macOS command files to run Ant
      non-modular/
  • Non-modular project
   maven/
      pom.xml
  • A sample Maven project file configured to generate with Apache Maven a demo JavaDoc using FlexDoc Doclet. This file is used by the command files below:
      site.(bat|sh|command)
  • Windows / Linux / macOS command files to run Maven
   gradle/
      modular/
  • Modular project:
         build.gradle
  • A simple Gradle buildfile to demonstrate integration of FlexDoc Doclet with Gradle
         make.(bat|sh|command)
  • Windows / Linux / macOS command files to run Gradle
      non-modular/
  • Non-modular project

Technical Requirements

FlexDoc/Javadoc requires the Javadoc Tool that comes with Java Development Kits (JDK) version 11 or later.
Javadoc is not a separate software but rather a part of the whole Java Development Kit (JDK), which you can freely download from either
Since FlexDoc/Javadoc is a pure Java application (both the Template Designer and Doclet GUI are based entirely on Java Swing), it is supposed to work on any operating system where Java can be installed.

Specifically, the FlexDoc/Javadoc software available includes

to run FlexDoc/Javadoc immediately on those operating systems.

See Windows Installation, Linux Installation and macOS Installation respectively.

Licensing / Processing Modes

Depending on your license, FlexDoc/Javadoc may work in three different modes: demo, full or trial.

Processing Mode Description
Demo Mode Covered by the Demo License, which is activated by default when no other licenses have been found. This mode allows you:
  • To run the Template Designer, however, without the possibility to save any your created/modified templates.
  • To run JavadocClasic templates with the full functionality. However, only limited number of Java classes can be documented.
Full Mode Activated in the presence of a Commercial License for FlexDoc/Javadoc. This mode allows you:
  • To use the Template Designer without limitation to created/modified any templates.
  • To run JavadocClasic templates without limitations.
  • To execute any custom templates created/modified under a Commercial or Trial License.
Trial Mode Activated in the presence of a trial license for FlexDoc/Javadoc. In this mode, the software will work the same as in the full mode except the following:
  • You may use FlexDoc/Javadoc working in trial mode only during the limited period of time (30 days) provided by your Trial License.
  • Any output documents generated in trial mode will be specifically distorted. Such documents may be used only for evaluation of this software. Any other use is prohibited!

Installation

Windows Installation

To install FlexDoc/Javadoc on Windows, please follow these steps:
  1. Unpack the downloaded archive at some location, which we shall designate as '{flexdoc-javadoc}'
  2. Go to {flexdoc-javadoc}\bin directory.

    Edit *.bat files to specify the JDK_HOME variable according to the location of JDK (Java Development Kit) version 11 (or later) installed on your system.

  3. If you have a license file flexdoc-javadoc.license (received by e-mail), copy it to {flexdoc-javadoc}\lib directory. This file should always be near the flexdoc-javadoc.jar file!
Now, everything must be ready.
Just run designer.bat or generator-modular.bat / generator-non-modular.bat !

Linux Installation

To install FlexDoc/Javadoc on Linux, please follow these steps:
  1. Unpack the downloaded archive at some location, which we shall designate as '{flexdoc-javadoc}'.
  2. If you have a license file 'flexdoc-javadoc.license' (received by e-mail), copy it to {flexdoc-javadoc}/lib directory.
  3. Go to {flexdoc-javadoc}/bin/linux directory.

    For each *.sh shell script file:

  4. Now, everything must be ready.
    Just run designer.sh or generator-modular.sh / generator-non-modular.sh !

macOS Installation

To install FlexDoc/Javadoc on macOS, please follow these steps:
  1. Unpack the downloaded archive at some location (e.g. on Desktop), which we shall designate as '{flexdoc-javadoc}'.
  2. If you have a license file 'flexdoc-javadoc.license' (received by e-mail), copy it to {flexdoc-javadoc}/lib directory.
  3. Go to {flexdoc-javadoc}/bin/macOS directory (open it with the Finder).

    Javadoc with FlexDoc Doclet is launched by generator-xxx.command shell script file.

    Because of security control, all macOS shell script files found in the downloaded FlexDoc/Javadoc archive cannot be executed straight. However, that is easy to overcome as described below for generator-xxx.command file:
    1. First, open generator-xxx.command with TextEdit (confirm in the warning box that it is OK to open it). Then, simply resave that file via File | Save menu. With that procedure, you will sign generator.command as its “owner/creator”, which is a precondition to be able running it.
    2. On top of that, you will need also to assign generator-xxx.command with the executable privilege. Run the Terminal and type in it 'chmod u+x' followed by a space and the full pathname of the script file (instead of typing it, just drag generator-xxx.command from the Finder into the Terminal window). Then, press Enter.
    Now at last, you can run generator-xxx.command from the Finder just by clicking twice on it.
  4. All the same is with designer.command that runs the Template Designer.

Integration Demos

Apache Ant

Please, make sure that Apache Ant is installed on your system. You can download Ant from: https://ant.apache.org. The download archive will contain exactly the Ant home directory, which you may unpack at any location (e.g. C:\apache-ant-1.10.13).

Running the demo is very simple:
  1. Go to the folder: {flexdoc-javadoc}/integrations/ant/modular
  2. Edit (to specify 'JAVA_HOME' and 'ANT_HOME' variables according to your Java and Ant locations) and run: After Ant ends you will see a new 'out' subdirectory.
  3. Open out/index.html to see the demo JavaDoc generated by FlexDoc Doclet.

Apache Maven

Please, make sure that Apache Maven is installed on your system. You can download Maven from: https://maven.apache.org. The download archive will contain exactly the Maven home directory, which you may unpack at any location (e.g. C:\apache-maven-3.9.0).

Running the demo:
  1. Go to the folder: {flexdoc-javadoc}/integrations/maven
  2. Edit (to specify 'JAVA_HOME' and 'M2_HOME' variables according to your Java and Maven locations) and run: After Maven ends you will see a new 'target' subdirectory.
  3. Open target/site/index.html file. Then, go to "Project Reports" and click "FlexDoc Doclet Demo". You will see the demo JavaDoc generated by FlexDoc Doclet.

Note: To pass those steps, Maven may need to download from Internet and install lots of plugins. (In fact, Maven is all made of various plugins, which it downloads from Internet dynamically as needed.) So, you must be connected to Internet during that.

Gradle

Please, make sure that Gradle is installed on your system. You can download / install Gradle from: https://gradle.org

Running the demo:
  1. Go to the folder: {flexdoc-javadoc}/integrations/gradle/modular
  2. Edit (to specify 'JAVA_HOME' and 'GRADLE_HOME' variables according to your Java and Gradle locations) and run: After Gradle ends you will see a new 'build' subdirectory.
  3. Open build/reports/flexdoc-doclet-demo/index.html to see the demo JavaDoc generated by FlexDoc Doclet.

Getting Help

Change Log

Please see: {flexdoc-javadoc}/CHANGES.html

Copyright© 2023 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.