FlexDoc/Javadoc - JavadocClassic - Samples


Framed HTML

This demo documentation has been generated using FramedDoc.tpl template by Java 8 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. So, you can appreciate how FlexDoc/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 SingleDoc.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 FlexDoc).

The following screenshot shows such an HTML generated from the whole javax.swing.text package (click to view the HTML):

RTF Demo

The following is a sample RTF documentation generated with the SingleDoc.tpl template.

You can download the whole RTF file here: SingleDoc.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 8 JDK Source Code.

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 FlexDoc 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. FlexDoc core is able to render in RTF the tables of any complexity and arbitrary layout defined with HTML tags!

RTF in OpenOffice.org

Since FlexDoc/Javadoc version 1.4, you can launch FlexDoc/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 JavadocClassic | SingleDoc.tpl main template, which has generated the RTF above (click to enlarge):

It is open with the Template Designer running under Linux Mint.