Products         Customers         News         Downloads         Licensing         Shop    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Buy
Licensing
Shop
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/Javadoc - Examples

RTF Demo

The following is a sample RTF documentation generated with the JavadocPro | PlainDoc.tpl template.

You can download the whole RTF file here: PlainDoc.rtf (536 KB)

This RTF document has been generated for 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 Java sources were taken from the Java SE 6 JDK Source Code available at http://download.java.net/jdk6/source/.

These screenshots show the first three pages of the RTF documentation (click to see in full size):

These are the java.lang package overview and the details of the java.lang.Enum class:
The following are the pages for 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). Here you can see how DocFlex is able to handle such an embedded HTML and render it with the appropriate formatting in RTF:
As you can see, the result looks nearly identical to what would be expected from best HTML browsers. Yet, this is MS Word displaying an RTF, which understands no HTML markup!

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!

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 / LibreOffice.org. (For more information, see also Documentation | FAQ | Generating RTF for OpenOffice.org.)

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

The following is the screenshot of JavadocPro | PlainDoc.tpl main template, which has generated the RTF above (click to enlarge):
It is open with the Template Designer running under Java 7 in openSUSE Linux v11.4.

HTML Demo

Framed HTML

This demo documentation has been generated using JavadocPro | FramedDoc.tpl template by Java 6 JDK sources of the following packages: The java.lang and java.util classes are particularly heavy laden with new language 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
Jumping directly to a particular detail

Single File HTML

The JavadocPro | PlainDoc.tpl template is able to produce not only RTF. It can generate 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):

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