FlexDoc/Javadoc - JavadocClassic - Templates

Basic Content Subtemplates

Generate pages or sections that provide primary information about the Java project.

overview.tpl

This template generates the Overview page/section (an equivalent of the 'overview-summary.html' file generated by the Standard Doclet).

The next screenshots show both an HTML page and an RTF section produced by this template (click to see in full size):

The description text found on the Overview page/section comes from a separate HTML file specified with the -overview option on the Javadoc command-line.

Template Location:

{flexdoc-javadoc}/templates/classic/lib/overview.tpl

Controlled By Parameter Group:

Generate | Overview

Called From:

FramedDoc.tpl, SingleDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, module-summary.tpl, package-summary.tpl, class-summary.tpl, text.tpl, block-tags.tpl, demo-incomplete.tpl

module.tpl

This template generates a Module Documentation page/section for every Java module being documented (an equivalent of the 'module-summary.html' file generated by the Standard Doclet), which includes:

The module description and block tags.
The list of packages contained in that module, with the summary description of each package and the indication if it is exported or open.
The lists of packages exported indirectly from other modules, which this module depends on.
The list of modules required by this module both directly and indirectly.
The list of services provided by this module (with the lists of their implementations).
The list of services used by this module.

The root section block of the template (click to see in full size):

The stock-section that generates all the lists:

On the following screenshots you can see both an HTML page and an RTF section generated by this template for the same module (click the screenshot to see in full size):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/module/module.tpl

Controlled By Parameter Group:

Generate | Module

Called From:

FramedDoc.tpl, SingleDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, annotations.tpl, className.tpl, text.tpl, block-tags.tpl, summary.tpl, doc-file-html.tpl, demo-incomplete.tpl

package.tpl

This template generates a Package Documentation page/section for every Java package being documented (an equivalent of the 'package-summary.html' file generated by the Standard Doclet), which includes package description, tags and summary tables of contained classes.

On the following screenshots you can see both an HTML page and an RTF section generated by this template for the same package (click the screenshot to see in full size):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/package/package.tpl

Controlled By Parameter Group:

Generate | Package

Called From:

FramedDoc.tpl, SingleDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, annotations.tpl, class-summary.tpl, text.tpl, block-tags.tpl, doc-file-html.tpl, demo-incomplete.tpl

class.tpl

This template generates a Class Documentation page/section for a class/interface/enum/annotation type.

Class Documentation may include the class description, various reference lists about it, as well as the details of all documented members of that class (except nested classes). This provides the bulk of the whole Java API documentation.

It is the most complex template, whose only little part is visible on this screenshot:

On the following screenshots you can see both an HTML page and an RTF section generated by this template for the same class (click to see in full size):

Template Location:

{flexdoc-javadoc}/templates/classic/lib/class/class.tpl

Controlled By Parameter Group:

Generate | Class

Called From:

FramedDoc.tpl, SingleDoc.tpl

Calls:

navbar.tpl, navbar-bottom.tpl, annotations.tpl, className.tpl, classLinkTitle.tpl, type.tpl, typeArguments.tpl, text.tpl, block-tags.tpl, summary.tpl, demo-incomplete.tpl