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
|
|
designer-1.4.bat
|
|
generator.bat
|
|
generator-1.4.bat
|
|
update_templates.bat
|
|
linux/
|
Files prepared for Linux Installation: |
linux/designer.sh
|
|
linux/designer-1.4.sh
|
|
linux/generator.sh
|
|
linux/generator-1.4.sh
|
|
linux/update_templates.sh
|
|
linux/docflex.config
|
|
lib/
|
DocFlex/Javadoc Runtime Environment: |
lib/docflex-javadoc.jar
|
|
lib/docflex-javadoc-1.4.jar
|
|
lib/docflex.config
|
|
config/
|
Configuration files (created and updated dynamically): |
config/designer.config
|
|
config/generator.config
|
|
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
|
|
templates/javadoc/PlainDoc.tpl
|
|
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
|
|
templates/JavadocPro/PlainDoc.tpl
|
|
demo/
|
Java files for demo generation: |
demo/java4/
|
|
demo/java5/
|
|
integrations/
|
The support files for integrations of DocFlex/Javadoc with other software systems |
integrations/ant/
|
Ant example files: |
integrations/ant/build.xml
|
|
integrations/ant/make.bat
|
|
integrations/ant/make.sh
|
|
integrations/maven/
|
Maven example files (see also Running Maven Demo): |
integrations/maven/pom.xml
|
|
integrations/maven/site.bat
|
|
integrations/maven/site.sh
|
|
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.
*.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.
docflex.license
, which you must have
received by e-mail, to lib
directory. This file should always be near
the docflex-javadoc.jar
file!
designer.bat
or generator.bat
!
*.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.)
docflex.license
, which you must have
received by e-mail, to lib
directory. This file should always be near the
docflex-javadoc.jar
file!
designer.sh
or generator.sh
!
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):
{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.
{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.
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.
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.
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
{docflex-javadoc}/CHANGES.html