FlexDoc/Javadoc - JavadocClassic - Parameters

About JavadocClassic parameters

«Show» parameter group

This parameter group controls the generation of various small fragments (like parts of qualified names, specific sections etc.)

Parameter Name / Type / Description
Inner Classes in Lists show.innerClasses : boolean

Specify whether to show inner classes in all class navigation and summary lists.

Inner classes are non-static nested classes. The Standard Doclet shows inner classes only in the Nested Class Summary of the corresponding enclosing classes. If this parameter is unselected (false), the inner classes will be still documented and visible in the Nested Class Summary of the corresponding enclosing classes.

Package Qualifiers show.qualifier : boolean

This parameter/group controls whether to show qualifying package name ahead of class names in parameters, types, referenced classes (like exception lists, implemented interfaces, etc.), specified with @see tags and {@link} tags in comments.

When this parameter is unchecked (false), all package qualifiers will be omitted.

To omit package qualifiers only for selected packages, please use the nested parameter: Omit For | Packages

Default Value:
The default value of this parameter is calculated according to the -noqualifier option provided by the Standard Doclet.

If that option is specified on the Javadoc command line as

-noqualifier all
the default value of this parameter is false, otherwise it is true.
Related Template:
className.tpl

Omit For

show.qualifier.omit

The parameter group to specify in which cases the package qualifier should be omitted.

Packages

show.qualifier.omit.packages : list of strings

Specify the packages whose qualifying names should be omitted from ahead of class names in the output.

The packages to omit are specified as the list of package patterns separated with newlines ('\n') 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.

Default Value:
The default value of this parameter is calculated according to the -noqualifier option provided by the Standard Doclet. If that option is found on the Javadoc command line like:

-noqualifier packagepattern1:packagepattern2:...

the specified list of package patterns will be used as the default value of this parameter.

External Links

show.qualifier.omit.externLinks : boolean

Specify whether to omit package qualifiers in the names linked to some external Javadoc-generated documentation according to -link and -linkoffline options provided on the Javadoc command-line.

Link Titles (Tooltips) show.linkTitle : boolean

Specify whether to generate hyperlink titles.

In HTML, hyperlink titles are specified using title attribute, like this:

<a ... title="link tooltip text"> ... </a>
Most browsers will interpret it as a hyperlink tooltip (a tiny window with the text that appears near the hyperlink when the mouse cursor is moved over it).

Such tooltips can be used to quickly see additional information about the linked text. For instance, when the link appears on a Java class name, its tooltip may reveal what kind of class it is (e.g. ordinary class, interface, enum or annotation type) and which package it belongs to.

Related Template:

classLinkTitle.tpl