DocFlex/Javadoc, Version 1.6.1

Release Notes

Package Contents
Technical Requirements
Licensing / Processing Modes
Installation
- Windows Installation
- Linux Installation
Running Maven Demo
Getting Help
Change Log

Package Contents

`LICENSE.html`	DocFlex Software License
`README.html`	this file
`CHANGES.html`	change log of DocFlex/Javadoc
`doc/`	DocFlex/Javadoc & DocFlex Technology Documentation
`*.bat`	Files prepared for Windows Installation:
`designer.bat`	launches the Template Designer (Java 5 / 6 / 7)
`designer-1.4.bat`	the same for Java 1.4
`generator.bat`	starts Javadoc with DocFlex Doclet to generate a demo documentation (Java 5 / 6 / 7)
`generator-1.4.bat`	the same for Java 1.4
`update_templates.bat`	updates your templates according to new DocFlex/Javadoc version or new license
`linux/`	Files prepared for Linux Installation:
`linux/designer.sh`	shell script file to launch the Template Designer (Java 5 / 6 / 7)
`linux/designer-1.4.sh`	the same for Java 1.4
`linux/generator.sh`	shell script to start Javadoc with the DocFlex Doclet and generate a demo (Java 5 / 6 / 7)
`linux/generator-1.4.sh`	the same for Java 1.4
`linux/update_templates.sh`	shell script to update your templates according to new DocFlex/Javadoc version
`linux/docflex.config`	DocFlex main configuration file prepared for Linux
`lib/`	DocFlex/Javadoc Runtime Environment:
`lib/docflex-javadoc.jar`	Java library compiled for Java 5 / 6 / 7
`lib/docflex-javadoc-1.4.jar`	Java library compiled for Java 1.4
`lib/docflex.config`	DocFlex main configuration file prepared for Windows. This file contains locations of other config files and various important settings.
`config/`	Configuration files (created and updated dynamically):
`config/designer.config`	Template Designer configuration file
`config/generator.config`	Generator configuration file
`templates/`	Ready to use template sets supplied with DocFlex/Javadoc
`templates/javadoc/`	The basic template set, which you can use to generate Java API documentation for any your projects in any of the supported output formats. This is an early version of standard templates provided before v1.6.0. It is able to generate only basic content: project overview, package summaries, class details. All Java 5 language features are fully supported. However, it will equally work under Java 1.4.
`templates/javadoc/FramedDoc.tpl`	The template to generate framed HTML documentation
`templates/javadoc/PlainDoc.tpl`	The template to generate single file documentation (in RTF or HTML format).
`templates/javadoc-1.4/`	The reduced variant of basic templates, with all support of Java 5 removed. It uses only features of Doclet API 1.4. This is roughly the same template set, which was provided by default before v1.5.0. The reason why it is included now is to help you to understand how everything works. Since it is designed only for Java 1.4, this template set is the simplest. Also, if your project does not involve Java 5 extra features (at least those to be documented), you may use this template set as a starting point for your own further customizations.
`templates/JavadocPro/`	The new JavadocPro template set that implements the most advanced Java API documentation generator with the support of filtering of classes and members by tags/annotations:
`templates/JavadocPro/FramedDoc.tpl`	The template to generate framed HTML documentation identical to classic JavaDoc.
`templates/JavadocPro/PlainDoc.tpl`	The template to generate single file documentation (in RTF or HTML format).
`demo/`	Java files for demo generation:
`demo/java4/`	Java 1.4 demo project
`demo/java5/`	Java 5.0 demo project
`integrations/`	The support files for integrations of DocFlex/Javadoc with other software systems
`integrations/ant/`	Ant example files:
`integrations/ant/build.xml`	A simple ANT buildfile to demonstrate integration of DocFlex Doclet with Apache Ant
`integrations/ant/make.bat`	Windows command file to run Ant
`integrations/ant/make.sh`	Linux shell script to run Ant
`integrations/maven/`	Maven example files (see also Running Maven Demo):
`integrations/maven/pom.xml`	A sample Maven project file configured to generate with Maven a demo JavaDoc using DocFlex Doclet. (This file is used by `site.bat` and `site.sh`)
`integrations/maven/site.bat`	Windows command file to generated a project site including a demo JavaDoc generated with DocFlex Doclet.
`integrations/maven/site.sh`	The same prepared for Linux

Technical Requirements

DocFlex/Javadoc requires the Javadoc Tool delivered with one of the following Java Development Kits:

(JDK 7 may be preferable as it is the fastest.)

Since DocFlex/Javadoc is a pure Java application (the Template Designer GUI is based entirely on Swing), it is supposed to work on any operating system with the installed JDK.

Specifically, the software includes both MS Windows BAT files and Linux shell script files to run DocFlex/Javadoc immediately on those operating systems. See Windows Installation and Linux Installation respectively.

We were also reported that DocFlex/Javadoc worked successfully under Mac OS X.

Licensing / Processing Modes

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

Limited Mode

The Limited Mode is covered by the Limited Free License. It is activated by default when no other licenses have been found. This mode allows you:

To run the Template Designer in demo mode. You will be able to investigate any functionality, however, unable to save any your created/modified templates.
To run the basic templates without limitations.
To run the JavadocPro templates with reduced functionality (only FramedDoc.tpl with some parameters disabled).
To use all output format generators (HTML, RTF, TXT) without limitations.

Full Mode

The Full Mode is activated in the presence of a Commercial or Academic License for DocFlex/Javadoc. This mode allows you:

To use the Template Designer without limitation to created/modified any templates.
To run both basic and JavadocPro templates without limitations.
To execute any custom templates created/modified under Commercial, Academic or Trial Licenses.
To use all output format generators (HTML, RTF, TXT) without limitations.

Trial Mode

The Trial Mode is activated in the presence of a Trial License for DocFlex/Javadoc. In this mode, the software will work the same as in the full mode except the following limitations:

You may use DocFlex/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 usage is prohibited!

Installation

Windows Installation

To install DocFlex/Javadoc on Windows, please follow these steps:

Unzip the downloaded archive.
Edit *.bat files in DocFlex/Javadoc root directory to specify the JDK variable according to the location of JDK (Java Development Kit) installed on your system.
Copy the DocFlex license key file docflex.license, which you must have received by e-mail, to lib directory. This file should always be near the docflex-javadoc.jar file!

Now, everything must be ready.
Just run designer.bat or generator.bat !

Linux Installation

To install DocFlex/Javadoc on Linux, please follow these steps:

Unzip the downloaded archive.
Edit *.sh shell script files contained in linux subdirectory to specify the JDK variable according to the location of JDK installed on your system. (Note: You may also need to edit "Permission" properties of each shell script file to allow it to be executed by Linux.)
Copy the DocFlex license key file docflex.license, which you must have received by e-mail, to lib directory. This file should always be near the docflex-javadoc.jar file!

Now, everything must be ready.
Just run designer.sh or generator.sh !

Running Maven Demo

First, of course, you need to have Maven installed on your system.

If you do not have Maven yet, download it from the Apache Maven web-site: http://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-2.2.1).

Further, please follow these steps (Windows platform):

Edit {docflex-javadoc}\integrations\maven\site.bat to specify 'JAVA_HOME' and 'M2_HOME' variables according to the locations of Java and Maven installed on your system.
Switch the current directory to {docflex-javadoc}\integrations\maven and run site.bat, which will generate the project web-site. After Maven ends you will see a new 'target' subdirectory.
Open target\site\index.html file. Then, go to "Project Reports" and click "DocFlex Doclet Demo". You will see the demo JavaDoc generated by DocFlex Doclet.

On Linux, everything is the same except that, instead of *.bat, you should use *.sh command files.

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 this.

Getting Help

The most up-to-date information about DocFlex/Javadoc can be found on the product home page: www.filigris.com | DocFlex/Javadoc.

We are always happy to hear any questions, suggestions, comments, etc. about this software.
Please, e-mail us to: support@docflex.com or contact@filigris.com

Change Log

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