Products         News         Downloads         Licensing         Shop         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
WSDLDoc
DiagramKit
Integrations
 DocFlex/Javadoc
Overview
Documentation
JavadocClassic
Templates
Parameters
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Use
Licensing
Shop
Support
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/Javadoc - JavadocClassic - Parameters

Parameter Tree


“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

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.

Note:

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.

Omit for Packages

show.qualifier.omit : 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 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.

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.
See Also:
DocFlex/Javadoc | Documentation | DocFlex Doclet | Handling Template Parameters | Multi-valued (List) Parameters
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.

Copyright© 2018 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.