Products         Services         Customers         News         Downloads         Licensing         Shop    

 DocFlex Technology

About
Key Features
Data Processing
Formatting
Templates / Template Designer
Documentation

 DocFlex/XML

About
Documentation
Samples
XMLDoc
XSDDoc
Tutorials

 DocFlex/Javadoc

About
Doclet
Examples
Templates
Tutorials

 DocFlex/Together

About
Examples
Basic Templates
Documentation
Tutorials

 Try

Downloads
Registration
Trial License

 Buy

Licensing/Pricing
Shop

 Company

News
Products
Services
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/Javadoc - Examples

RTF demo

The following screenshots demonstrate sample RTF documentation generated with the PlainDoc.tpl template.

This RTF document has been generated from only four classes directly specified on the Javadoc command line:

  1. java.lang.Enum
  2. java.util.EnumSet
  3. javax.swing.text.Document
  4. javax.swing.text.JTextComponent

The class' sources were taken from the Java SE 6 JDK Source Code available at http://download.java.net/jdk6/.

These screenshots show pages of the RTF documentation generated by java.lang.Enum and java.util.EnumSet classes (which both use the Generic Type language feature introduced only since Java 5):

java.lang.Enum java.util.EnumSet java.util.EnumSet
The following are the pages dedicated to javax.swing.text.Document interface and javax.swing.text.JTextComponent class, whose Java sources contain comments richly formatted with various embedded HTML tags (including images). So, the produced documentation can show in the full beauty how DocFlex is able to handle such an embedded HTML and render it with the appropriate formatting in RTF:
javax.swing.text.Document javax.swing.text.Document javax.swing.text.Document
javax.swing.text.Document javax.swing.text.JTextComponent javax.swing.text.JTextComponent
As you can see, the produced result looks nearly identical to what would be expected from the best HTML browsers. But this is the RTF displayed in MS Word!

The images were picked automatically by the generator from their original locations (in doc-files subdirectories) within the provided Java sources. Please notice also a table in the bottom-right screenshot. DocFlex core is able to render in RTF the tables of any complexity and arbitrary layout defined with HTML tags!

You can download and investigate the whole RTF demo file by this link: PlainDoc.rtf (409 Kb).

RTF in OpenOffice.org

Since DocFlex/Javadoc version 1.4, you can launch DocFlex/Javadoc under Linux and generate RTF documentation to open it in OpenOffice.org. (For more information, see also Doclet | Generating RTF for OpenOffice.org.)

Here is how such an RTF looks when open with OpenOffice.org Writer (click to enlarge):

RTF documentation open with OpenOffice.org Writer under Linux
The following is the screenshot of PlainDoc.tpl main template, which has generated the RTF above (click to enlarge):
PlainDoc.tpl (under Linux)
It is open with the Template Designer running under Java 6 in openSUSE Linux v10.2.

HTML demo

Framed HTML

Now, let's look what a result can be produced using FramedDoc.tpl template.

The following screenshot shows a framed documentation generated from the Java 6 JDK sources of java.lang package, its subpackages and java.util package alone. Those sources are particularly heavy laden with all the new features introduced in Java 5.0. So, you can appreciate how DocFlex/Javadoc is able to handle such a code (click on the picture to see the live HTML):

Framed HTML documentation

Single-File HTML

The PlainDoc.tpl template can generated not only RTF. It is equally able to produce a single-file HTML documentation (as well as in any other output format currently supported by DocFlex).

The following screenshot shows such an HTML generated from the whole javax.swing.text package (click to download a zip-archive of this demo):

Single-file HTML documentation

Copyright© 2003-2008 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.