FlexDoc/Javadoc - JavadocClassic - Parameters

About JavadocClassic parameters

«Generate» parameter group

The parameter group to control the overall content of the generated Java API documentation.

Parameter Name / Type / Description
Title Page gen.titlePage : boolean

Specify whether to generate the Title Page.

The title page is available only in single file documentation (generated with SingleDoc.tpl main template). When generated, it will be the very first page of the entire documentation.

Related Template:

The title page is generated by title-page.tpl template.
See Also:
“Documentation Title” parameter
Table Of Contents gen.toc : boolean

Specify whether to insert the Table Of Contents of the documentation.

Currently, the Table Of Contents is available only in RTF documentation (generated with SingleDoc.tpl main template). However, it is not actually generated. Rather, a special RTF “{TOC}” field is inserted. The real Table Of Contents is generated by MS Word according to that field and style/level paragraph settings specified on the headings of some documentation section. This produces the Table Of Contents with the following structure: 

Overview.......................
   Package Summary.............
   All Classes Summary.........
package1.......................
   class1......................
   class2......................
   ...
package2.......................
   ...
...
To have the Table Of Contents generated, the document should be loaded in MS Word and the {TOC} field updated. For instance, you can press Ctrl-A (select all) and then F9 (update selected fields).

Related Template:

The Table Of Contents is generated by TOC.tpl template.
See Also:
“Pagination | Start from new page | Table Of Contents” parameter
Overview gen.overview : boolean

Specifies whether to generate the Overview page/section (an equivalent of the overview-summary.html file generated by the Standard Doclet).

It is the front page of Java API documentation and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

In the case of framed HTML documentation (generated by FramedDoc.tpl), the Overview page is always generated and, therefore, this parameter is fixed.

In the case of single file (RTF) documentation (generated by SingleDoc.tpl), the Overview section may also include a summary of all documented classes. This is controlled by “Generate | Overview | All Classes Summary” parameter.

Related Template:

The Overview page/section is generated by overview.tpl template.
See Also:
“Pagination | Start from new page | Overview” parameter

Package Summary

gen.overview.packages : boolean

Specify whether the documentation Overview will include the summary of all documented packages.

These are the packages containing any documented classes. For instance, when you document only a single class, there will be a package containing it, which will appear in the overview package summary, when this parameter is selected.

Related Template:

A package summary table is generated by package-summary.tpl template.

Package Groups

gen.overview.packages.groups : list of strings

This parameter is an analog of -group option provided by the Standard Doclet. It allows you to separates packages on the overview page into whatever groups you specify, one group per table.

The parameter accepts multiple (list) value. Each value item specifies a single package group.

Specifying Package Group

A package group is specified as follows:
packagepattern1:packagepattern2:...::groupheading
where
  • packagepattern can be any package name, or can be the start of any package name followed by an asterisk (*). The asterisk is a wildcard meaning “match any characters”. This is the only wildcard allowed.
  • groupheading can be any text (including white spaces). This text is placed in the table heading for the group
Example:
java.*:javax.*::This is a title

Specifying Multiple Package Groups

Different package groups should be specified with separate items of the whole parameter value. Each value item should define a single group as described above. The items must be separated with one of the allowed item separators (newline or ';').

Example:

java.awt.*:javax.swing.*::Java GUI API
org.w3c.*::W3C API
or the same as a single line:
java.awt.*:javax.swing.*::Java GUI API;org.w3c.*::W3C API
The last form can be used to specify both groups on the Javadoc command line:
-p:gen.overview.packages.groups "java.awt.*:javax.swing.*::Java GUI API;org.w3c.*::W3C API"

Because here the full parameter value contains spaces, it is enclosed in quotes to have it treated as a single command-line argument.

The same can be also specified with two -p options:
-p:gen.overview.packages.groups "java.awt.*:javax.swing.*::Java GUI API" -p:gen.overview.packages.groups "org.w3c.*::W3C API"
Each -p option adds a separate value item to the 'gen.overview.packages.groups' parameter.
Using Escapes
Each character that serves as a value item separator can be equally used within the value item if escaped with a backslash. If a backslash is not consumed by an escape it will be remained in the text as is. To make sure that a backslash is not part of some escape, you may add another backslash.

For example, a package group with the title:

The API to process ';' and '\' in text
can be specified like this:
textmill.semicolon.*:textmill.slash.*::The API to process '\;' and '\\' in text

Sorting Order

The groups appear on the page in the order of the parameter's value items specifying each group (i.e. in the same order as the package groups are specified on the command line). The packages are alphabetized within a group.

Packages Outside Groups

If you specify no package groups (the parameter value is empty), all packages are placed in one group with the heading «Packages».

If the all groups do not include all documented packages, any leftover packages appear in a separate group with the heading «Other Packages», which is printed the last.

Default Value

The default value of this parameter is produced from all -group options found on the Javadoc command line. Each -group option is converted to a single value item of this parameter.

So, you can use Standard Doclet's -group options instead of specifying this parameter directly.

All Classes Summary

gen.overview.allClasses : boolean

Specify whether the documentation Overview will include the summary of all documented classes.

Related Template:

A class summary table is generated by class-summary.tpl template.
See Also:
“Pagination | Start from new page | All Classes Summary” parameter
Package Overviews gen.package : boolean

Specifies whether to generate a Package Overview page/section for every documented package (an equivalent of the package-summary.html file generated by the Standard Doclet).

When this parameter is selected (true), a Package Overview will be generated for every package containing at least one documented class.

This parameter/group is available only in SingleDoc.tpl template. In case of framed documentation, the Package Overviews are generated anyway.

Related Template:
A Package Overview page/section is generated by package.tpl template.
See Also:
“Pagination | Start from new page | Package Overviews” parameter

Class Summary

gen.package.classes : boolean

Specify whether Package Overview will include the summary of all documented classes contained in that package.

Related Template:

A class summary table is generated by class-summary.tpl template.
Class Detail gen.class : boolean

Specify whether to generate a Class Details page/section for each class or interface being documented.

It includes 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.

In the case of framed HTML documentation (generated by FramedDoc.tpl), the class details are always generated and, therefore, this parameter cannot be unchecked.

Related Template:
Each Class Detail page/section is generated by class.tpl template.
See Also:
“Pagination | Start from new page | Class Detail” parameter

Member Summary

gen.class.member.summary : boolean

Specifies whether to include the summary of class members (i.e. fields and methods) and inner classes.

Inherited Members

gen.class.member.summary.inherited : boolean

Specify whether to include the lists of inherited inner classes, fields or methods.

Exclude for Packages

gen.class.member.summary.inherited.exclude : list of strings

This parameter allows you to exclude the lists of inner classes, fields or methods that are inherited from the classes/interfaces which belong to the specified packages.

For instance, you may want to suppress the long lists of the class members inherited from standard Java API classes and, thereby, to reduce the output documentation

The packages, whose classes/interfaces should not appear in the "inherited from ..." lists, are specified as the list of package patterns separated with newlines or colons (:). For example:

java.lang.*
javax.swing.*
A package pattern can be any package name, or can be the start of any package name followed by an asterisk (*). The asterisk is a wildcard meaning “match any characters”. This is the only wildcard allowed.

See Also:

FlexDoc/Javadoc | Documentation | FlexDoc Doclet | Handling Template Parameters | Multi-valued (List) Parameters

Member Detail

gen.class.member.detail : boolean

Specify whether to include the details of class members (i.e. fields and methods). If false (unchecked), only overview for each class will be generated without the details for the class' members.

Constant Field Values

gen.class.member.detail.constantValues : boolean

Specify whether to show the constant field values directly in the field documentation headers. For example:

public static final byte CONTROL = 15
This is an alternative to the constant field values page offered by the standard Javadoc (which can be equally generated by JavadocClassic template set).

See Also:

“Generate | Cross-Reference Pages | Constant Field Values” parameter
Cross-Reference Pages gen.refs

The parameter group to control the generation of various reference pages.

These parameters are avalaible only in FramedDoc.tpl main template, which generates framed HTML documentation.

All Classes Summary

gen.refs.allClasses : boolean

Specify whether to generated All Class Summary page, which is loaded when clicking on “All Classes” item in the navigation bar.

It is a replacement of the standard 'allclasses-noframe.html' file (generated by the Standard Doclet), which is intended to view in NO FRAMES mode.

Unlike the standard one, All Class Summary page shows not just the list of pure class names but rather a summary of all classes with the first sentence description of each class. It is also available in the FRAMES mode.

Related Template:

The All Classes page is generated by class-summary.tpl template.

Use (Package/Class)

gen.refs.use : boolean

Specify whether to generate a “use” page for each documented class and package. The page describes what packages, classes, methods, constructors and fields use any API of the given class or package.

Default Value:

The default value of this parameter is set according to the -use option found on the Javadoc command line. If this option is specified, the default value is true, otherwise it is false.
Related Templates:
The Use pages are generated by package-use.tpl and class-use.tpl templates.

Tree (Class Hierarchy)

gen.refs.tree : boolean

Specify whether to generate class/interface hierarchy pages. These are the pages you reach using the “Tree” button in the navigation bar.

Default Value:

The default value of this parameter is set according to the -notree option found on the Javadoc command line. If this option is specified, the default value is false, otherwise it is true.
Related Template:
The Class Hierarchy pages are generated by class-tree.tpl template.

Deprecated List

gen.refs.deprecatedList : boolean

Specify whether to generate the deprecated API page ('deprecated-list.html' file), which contains the list of deprecated APIs, and the “Deprecated” link in the navigation bar to that page.

This parameter has no effect on the generation of the deprecated API throughout the rest of the documentation, which is controlled separately by “Include | Deprecated API” parameter.

Default Value:
The default value of this parameter is set according to the -nodeprecatedlist option found on the Javadoc command line. When this option is specified, the default value is false, otherwise it is true.
Related Template:
The Deprecated API page is generated by deprecated-list.tpl template.

Index

gen.refs.index : boolean

Specify whether to generate an index.

Default Value:

The default value of this parameter is set according to the -noindex option found on the Javadoc command line. If this option is specified, the default value is false, otherwise it is true.
Related Templates:
The index is generated by two templates:
  1. index-all.tpl generates a single 'index-all.html' file
  2. index-letter.tpl generats either separate index files for each particular letter or corresponding sections of the single index file.

Split

gen.refs.index.split : boolean

Specify whether to split the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.

Default Value:

The default value of this parameter is set according to the -splitindex option found on the Javadoc command line. If this option is specified, the default value is true, otherwise it is false.

Serialized Form

gen.refs.serializedForm : boolean

Specify whether to generate the serialized form page.

That page contains information about serializable and externalizable classes. Each such class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking “Serialized Form” in the “See also” section of the class comment.

Related Template:

The Serialized Form page is generated by serialized-form.tpl template.

Constant Field Values

gen.refs.constantValues : boolean

Specify whether to generate the constant field values page ('constant-values.html' file), which lists the static final fields and their values.

Related Template:

The Constant Field Values page is generated by constant-values.tpl template.
See Also:
“Generate | Class Detail | Member Detail | Constant Field Values” parameter
Help gen.help : boolean

Specify whether to generate the help page. This is the page you reach using the “Help” button in the navigation bar.

Default Value:

The default value of this parameter is set according to the -nohelp option found on the Javadoc command line. If this option is specified, the default value is false, otherwise it is true.
Related Template:
The Help page is generated by help-doc.tpl template.
Navigation bar gen.navbar : boolean

Specify whether to generate the navigation bar located at the top and bottom of the generated HTML pages.

This parameter/group is avalaible only in FramedDoc.tpl main template, which generates framed HTML documentation.
It has no effect on the bottom text specified with “Generate | Bottom Text” parameter.

Default Value:

The default value of this parameter is set according to the -nonavbar option found on the Javadoc command line. If this option is specified, the default value is false, otherwise it is true.
Related Template:
All navigation bars are generated by the same navbar.tpl template.

Header Text

gen.navbar.headerText : text

This parameter is similar to -header option provided by the Standard Doclet. It specifies the header text to be placed at the top of each detail page. The header will be placed to the right of the upper navigation bar.

Additionally, when the header text is specified, it is inserted also at the top of the 'overview-frame.html' file (generated by overview-frame.tpl), used in the upper-left frame.

Default Value:

The default value of this parameter will be taken from the -header option found on the Javadoc command line.

Footer Text

gen.navbar.footerText : text

This parameter is similar to -footer option provided by the Standard Doclet. It specifies the footer text to be placed at the bottom of each each detail page. The footer will be placed to the right of the lower navigation bar.

The footer text may contain HTML tags and white space.

Note:

When the footer text is not specified, the header text (specified in “Header Text” parameter) will be used instead of it.
Default Value:
The default value of this parameter will be taken from the -footer option found on the Javadoc command line.
Bottom Text gen.bottomText : text

This parameter is similar to -bottom option provided by the Standard Doclet. It specifies the text to be placed at the bottom of each detail page/file, below the lower navigation bar.

The bottom text may contain HTML tags and white space.

Default Value:

The default value of this parameter will be taken from the -bottom option found on the Javadoc command line.
Related Template:
navbar-bottom.tpl
About (footer) gen.about : enum {"full", "short", "none"}

Specify whether to generate the “About” section added at the bottom of each generated document.

This section shows certain information about FlexDoc/Javadoc software, which powers this Java API Documentation Generator.

Possible Values:

"full"
Generate the detailed information.
"short"
Generate only a brief notice.
"none"
Do not generate the “About” section.
Related Template:
Actually, all what you can see in the “About” section is generated entirely by about.tpl template.