FlexDoc/Javadoc - JavadocClassic - Parameters

Available only in SingleDoc.tpl

When both module/package groupings are enabled, the whole generated content will look as follows:

Title Page
Table Of Contents
Overview
Module1    – all modules, sorted alphabetically by names
  Package1 – all packages within the module, sorted by full names
    Class1 – all classes within the package, sorted by short names
    Class2
    ...
  Package2
  ...
Module2
...

Title Page
Table Of Contents
Overview
Module1  – all modules, sorted by names
Module2
...
Package1 – all packages, sorted by full names
Package2
...
Class1   – all classes, sorted by short names
Class2
...

When you need to document just a few classes:

1. Enable only class details (see: Generate Details | Class)
2. Disable all groupings

Available only in SingleDoc.tpl

When selected (true), the generated content will look as follows:

Title Page
Table Of Contents
Overview
Module1            – a module group; modules are sorted
                     alphabetically by names
  Packages/Classes – details of all packages/classes in the
                     module, which may be grouped according
                     to the parameter: Grouping | By Packages
Module2
...

Each module group is started with the Module Documentation section, whose generation is controlled by the parameter: Generate Details | Module. When Module Documentation is disabled, only module group heading will be generated.

Title Page
Table Of Contents
Overview
Module1           – all modules, sorted by names
Module2
...
Packages/Classes  – details of all packages and classes,
                    which may be grouped according to
                    the parameter: Grouping | By Packages

• Generate | Module
• Pagination | Start from new page | Module
• Pagination | Orientation | Module

Available only in SingleDoc.tpl

When selected (true), the generated content will look as follows (case of non-modular project):

Title Page
Table Of Contents
Overview
Package1 – a package group; packages are sorted
           alphabetically by qualified names
  Class1 – details of all classes in the package sorted
  Class2   alphabetically by class short names
  ...
Package2
...

Each package group is started with the Package Documentation section, whose generation is controlled by the parameter: Generate Details | Package. When Package Documentation is disabled, only package group heading will be generated.

Title Page
Table Of Contents
Overview
Package1 Overview – all packages, sorted by qualified names
Package2 Overview
...
Class1            – details of all classes sorted alphabetically
Class2              by class short names
...

• Generate | Package
• Pagination | Start from new page | Package
• Pagination | Orientation | Package

Available only in SingleDoc.tpl

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 the template: title-page.tpl

By default, it just prints (with a large font and centered) the text specified in the “Documentation Title” parameter. That text may also include some HTML markup, which will be recognized and rendered.

You may easily edit the title-page.tpl template and add/change whatever you need (e.g. you can add you company logo or other images).

Documentation Title

Available only in SingleDoc.tpl

However, in the case of RTF, the Table Of Contents 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.

Overview.......................
   Module Summary..............
   All Package Summary.........
   All Classes Summary.........
Module1........................
   Package1....................
      Class1...................
      Class2...................
      ...
   Package2....................
   ...
Module2........................
...

Related Template:

The Table Of Contents is generated by TOC.tpl template.

Generate | Grouping

Pagination | Start from new page | Table Of Contents

Pagination | Orientation | Table Of Contents

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

The Overview page is the front page of the entire documentation generated by this template set. It provides:

• An overall description of the documented Java project or the set of modules/packages.

  It comes from a separate HTML file specified with the -overview option on the Javadoc command-line.

• The summary of all modules, which is generated only in case of modular Java project/sources.
• The summary of all packages, which can be generated in case of both modular and non-modular project/sources. This depends on the setting of the nested parameter: Package Summary

In case of single-file RTF/HTML documentation (generated by SingleDoc.tpl), the Overview section may also include:

• The summary of all documented classes (in all cases). This is controlled by the nested parameter: All Class Summary

The Overview page/section is generated by the template: overview.tpl

• Pagination | Start from new page | Overview
• Pagination | Orientation | Overview

Specify if the Overview should include a module summary.

Note:

This parameter is used only in case of modular Java project/sources.

A module summary table is generated by the template: module-summary.tpl

Pagination | Start from new page | Overview | Module Summary

Specify if the Overview should include a package summary.

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.

Possible Choices:

"non-modular only"

Generate the package summary only in case of non-modular Java project/sources.

Generate the package summary in any case.

Do not generate the package summary.

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

Pagination | Start from new page | Overview | Package Summary

This parameter is the 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.

Notes:

• This parameter is used only in case of non-modular Java project/sources.
• The parameter accepts multiple (list) value. Each value item specifies a single package group.

• Specifying Package Group
• Specifying Multiple Package Groups
• Using Escapes
• Group Ordering
• Packages Outside Groups
• Default Value

Specifying Package Group

packagepattern1:packagepattern2:...::groupheading

• packagepattern

  A qualified name pattern can be any Java qualified name appropriate in the given context, or it can be the start of such a qualified 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

java.*:javax.*::This is a title

Specifying Multiple Package Groups

Example:

java.awt.*:javax.swing.*::Java GUI API
org.w3c.*::W3C API

java.awt.*:javax.swing.*::Java GUI API;org.w3c.*::W3C API

-p "gen.overview.packages.groups=java.awt.*:javax.swing.*::Java GUI API;org.w3c.*::W3C API"

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"

Using Escapes

For example, a package group with the title:

The API to process ';' and '\' in text

textmill.semicolon.*:textmill.slash.*::The API to process '\;' and '\\' in text

Group Ordering

Packages Outside Groups

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

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

Available only in SingleDoc.tpl

Related Template:

A class summary table is generated by the template: class-summary.tpl

Pagination | Start from new page | Overview | Class Summary

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

Module Documentation is generated mostly according the information found in the module declaration file (module-info.java). It includes:

• The module description and block tags (see also “Include | Descriptions” parameter).
• 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.

Notes:

• This parameter is used only in case of modular Java project/sources.
• In case of framed HTML documentation (generated by FramedDoc.tpl), you reach the releavant Module Documentation page using the «Module» button in the navigation bar.

Module Documentation pages/sections are generated by the template: module.tpl

• Generate | Grouping | By Modules
• Pagination | Start from new page | Module
• Pagination | Orientation | Module

Specify the granularity of the module information that appears Module Documentation.

Possible Choices:

"documented only"

Show only those items that are included in the documentation or directly related to them.

This setting may be useful, when you need to document only a few packages or classes from a large project and do not want to overburden the Module Documentation with unrelated details.

This includes:

• The list of documented packages enclosed in this module. If the module declaration contains any exports/opens directives for those packages, they will be documented as well.
• The lists of documented packages exported indirectly from other modules, which this module depends on.
• The list all required modules both directly and indirectly.
• The list of documented services provided by this module, along with their documented implementations.
• The list of documented services used by this module.

Show all API level items.

This setting represents the module content from the viewpoint of users of its open API, with hiding all implementation details.

This includes:

• The list of all exported packages contained in this module. No qualified exports will be included. If a listed package is fully open (without qualifiers), that will be shown as well.
• The lists of all packages exported indirectly from other modules, which this module depends on. No qualified indirect exports will be included.
• The list all required modules both directly and indirectly.
• The lists of all services provided and used by this module, which are declared in some fully exported packages.

Show all details found in the module declaration plus any documented packages that are not mentioned there:

• The list of all packages specified in any exports/opens directives found in the module declaration. All documented packages will be included in the list as well, regardless if they are mentioned in the module declaration. Any export/open qualifiers of the listed packages will be shown too.
• The lists of all packages exported indirectly from other modules regardless of export qualifiers.
• The list all required modules both directly and indirectly.
• The list of all services provided by this module, along with all their implementations.
• The list of all services used by this module.

Show all available details about the content of this module:

• The list of all packages contained in this module. Any exports/opens directives for those packages will be documented as well.
• The lists of all packages exported indirectly from other modules regardless of export qualifiers.
• The list all required modules both directly and indirectly.
• The list of all services provided by this module, along with all their implementations.
• The list of all services used by this module.

No lists of packages, required modules and services will be generated.

• The generated package summary is supplied with a special note/footnote that briefly indicates which packages are included in that summary (according to the setting of this parameter). If you don't need that note, you can disable it using the nested parameter:

  Generate | Module | Contents | Package Note

• Module Documentation will also include the description and block-tags, whose generation is controlled by the parameter:

  Include | Descriptions

• The documenting of indirect dependencies (the lists of packages exported indirectly from other modules and the modules required indirectly) is controlled by the parameter:

  Generate | Module | Indirect Dependencies

Specify whether to add a special note/footnote that briefly describes which module packages are included in the Package Summary generated in the Module Documentation according to the setting of the parameter:

Generate | Module | Contents

Specify if Module Documentation should include the information obtained from the declarations of other modules required by this one:

• The lists of packages exported indirectly from other modules, which this module depends on.
• The list of indirectly required modules.

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

Package Documentation may include:

• The package description and block tags. These are obtained either from the package-info.java or the legacy package.html found in the package directory. See also parameter: Include | Descriptions
• The summary of documented classes contained the package, which is broken into the following categories:
  • Interfaces
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
  The generation of the class summary is controlled by the nested parameter: Class Summary

In case of framed HTML documentation (generated by FramedDoc.tpl), you reach the releavant Package Documentation page using the «Package» button in the navigation bar.

Package Documentation pages/sections are generated by the template: package.tpl

• Generate | Grouping | By Packages
• Pagination | Start from new page | Package
• Pagination | Orientation | Package

Specify if Package Documentation should include the summary of all documented classes contained in that package.

Related Template:

A class summary table is generated by the template: class-summary.tpl

Specify whether to generate a Class Documentation page/section for each

• 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.

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

Related Template:

Class Documentation pages/sections are generated by the template: class.tpl

• Pagination | Start from new page | Class
• Pagination | Orientation | Class

Available only in SingleDoc.tpl

Nested classes may be numerous and can overwhelm the single-file documentation with unnecessary details. However, it is possible to document only some of them using the nested “Names” parameter.

Available only in SingleDoc.tpl

The classes are specified as the list of their qualified names separated with newlines ('\n') or colons (':'), for example:

java.lang.System.Logger
java.lang.System.Logger.Level
javax.xml.catalog.CatalogFeatures.Builder
javax.xml.catalog.CatalogFeatures.Feature

java.lang.System.*
javax.xml.catalog.CatalogFeatures.*

A qualified name pattern can be any Java qualified name appropriate in the given context, or it can be the start of such a qualified name followed by an asterisk (*). The asterisk is a wildcard meaning match any characters. This is the only wildcard allowed.

Specifies if the Class Documentation should include the summary of class members, i.e.

• fields
• enum constants
• constructors
• methods
• annotation type elements

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

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 qualified name pattern can be any Java qualified name appropriate in the given context, or it can be the start of such a qualified name followed by an asterisk (*). The asterisk is a wildcard meaning match any characters. This is the only wildcard allowed.

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.

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

public static final byte CONTROL = 15

See Also Parameter:

Generate | Cross-Reference Pages | Constant Field Values

Available only in FramedDoc.tpl

Available only in FramedDoc.tpl

These are the pages you reach via the «Use» button in the navigation bar.

Default Value:

The default value of this parameter is set according to the -use option found on the Javadoc command-line.

package-use.tpl, class-use.tpl

Tree (Class Hierarchy)

Available only in FramedDoc.tpl

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.

class-tree.tpl

Available only in FramedDoc.tpl

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

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.

deprecated-list.tpl

Available only in FramedDoc.tpl

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:

serialized-form.tpl

Available only in FramedDoc.tpl

Related Template:

constant-values.tpl

Generate | Class | Member Detail | Constant Field Values

Available only in FramedDoc.tpl

It provides the alphabetic list all documented classes with the summary description for each. You reach this page using the «All Classes» link in the navigation bar.

See Also Parameter:

Show | Inner Classes in Lists

class-summary.tpl

Available only in FramedDoc.tpl

It provides the alphabetic list all documented packages with the summary description for each. You reach this page using the «All Packages» link in the navigation bar.

Related Template:

package-summary.tpl

Index

Available only in FramedDoc.tpl

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.

index-all.tpl, index-letter.tpl

Split

Available only in FramedDoc.tpl

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.

Available only in FramedDoc.tpl

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.

help-doc.tpl

Available only in FramedDoc.tpl

This parameter has no effect on the bottom text specified with the parameter: Generate | Bottom Text

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.

navbar.tpl

Available only in FramedDoc.tpl

Additionally, when the header text is specified, it is inserted also at the top of the all package list (overview-frame.html file), used in the upper-left frame.

The header text may contain HTML tags and white space.

Default Value:

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

Available only in FramedDoc.tpl

The footer text may contain HTML tags and white space.

When the footer text is not specified, the header text (specified in "Header Text" parameter) will be used instead of it.

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

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.

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 Choices:

"full"

Generate the detailed information.

Generate only a brief notice.

Do not generate the "About" section.

about.tpl