FlexDoc/Javadoc - JavadocClassic - Templates
Fragment Subtemplates
Called from other templates to generate small (but frequent) fragments of the documentation.annotations.tpl
This template generates the list of annotations (along with all related hyperlinks) of- module
- package
- class
- member
- constructor/method parameter
- type parameter
- type
Besides the annotation lists, this template can generate also the representation of a specific annotation value. That is used in block-tags.tpl to represent the default value of an Annotation Type Element.
The following screenshots show some important stock-sections of this template. Stock-sections are template components that work similar to procedures of ordinary programming languages. Each stock-section can be called from different locations of the template (including even from itself).This stock-section reproduces a single annotation (as it would look in the Java code):
- As a monospaced text flow possibly with non-collapsible spaces and new lines
- As a grid (table), if the output format is HTML and this is a multi-line annotation to be put in a separate paragraph (in case of module/package/class/member header), so as to avoid its distortion when the annotation type name is extended automatically with the external link icon using CSS.
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/annotation/annotations.tpl
Called From:
- module.tpl, package.tpl, class.tpl, type.tpl, typeArguments.tpl, serialized-form.tpl, block-tags.tpl
Calls:
className.tpl
This template generates the name of a Java class and the hyperlink from it to the class documentation (click to see in full size):
-
The “Show | Package Qualifiers” parameter is set
true. - The class is not documented locally in this documentation.
- The external documentation for this class is not provided or qualifiers must not be omited for external links; see parameter: Show | Package Qualifiers | Omit For | External Links
- The class' package is not the one, whose qualifier must be omited; see parameter: Show | Package Qualifiers | Omit For | Packages
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/class/className.tpl
Called From:
- module.tpl, class.tpl, class-summary.tpl, serialized-form.tpl, annotations.tpl, type.tpl, doc-reference.tpl, block-tags.tpl
Calls:
classLinkTitle.tpl
Generate the title (tooltip) for a class hyperlink:
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/class/classLinkTitle.tpl
Called From:
- class.tpl, class-summary.tpl, package-use.tpl, class-use.tpl, class-tree.tpl, deprecated-list.tpl, index-letter.tpl, serialized-form.tpl, constant-values.tpl, allclasses-frame.tpl, package-frame.tpl, annotations.tpl, className.tpl
type.tpl
This template generates the text representation of a Java type the same as in Java code and with all relevant hyperlinks.
Examples:
Here is the template's root section block,
which contains just a call of
int
boolean
- primitive type
java.lang.String
- class
int[]
String[]
- array
Comparator<String>
java.util.Map<? extends K,? extends V>
- parametrized type
V
- type variable
'Type' stock-section that generates
the actual type representation. Such a construct is needed because that stock-section recursively calls itself and therefore needs to have a name.
Click to see in full size:
'Type' stock-section that generates the type representation:
'Type' stock-section in expanded form:
 "type.tpl - “Type” stock-section (expanded)")
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/class/type.tpl
Called From:
- class.tpl, class-use.tpl, index-letter.tpl, serialized-form.tpl, constant-values.tpl, typeArguments.tpl
Calls:
typeArguments.tpl
This template generates the representation of type arguments ot type parameters (their declaration).
Examples:
That everything is generated by the template's root section block (click to see in full size):
<String>
<?>
<? extends K,? extends V>
- type arguments
<T>
<T extends Object & Comparable<? super T>>
- declarations of a type parameter
T
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/class/typeArguments.tpl
Called From:
- class.tpl, class-summary.tpl, class-use.tpl, index-letter.tpl, serialized-form.tpl, constant-values.tpl, type.tpl
Calls:
navbar.tpl
This template generates all navigation bars found the framed HTML documentation.Each navigation bar for a particular page type is generated by the corresponding Area Section visible on the template screenshot (click to see in full size):
'$type'
passed internally to this template from the calling one, which generates the whole page.
The expanded Area Section below is specified to generate navigation bars for class documentation pages (which are generated by the class.tpl template):
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/frgm/navbar.tpl
Controlled By Parameter Group:
Called From:
- class-summary.tpl, class-tree.tpl, class-use.tpl, class.tpl, constant-values.tpl, deprecated-list.tpl, help-doc.tpl, index-all.tpl, index-letter.tpl, overview.tpl, package-use.tpl, package.tpl, serialized-form.tpl
navbar-bottom.tpl
Generates overall footer of each detail page in framed HTML documentation including footer navigation bar, bottom text and «About» section.
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/frgm/navbar-bottom.tpl
Called From:
- class-summary.tpl, class-tree.tpl, class-use.tpl, class.tpl, constant-values.tpl, deprecated-list.tpl, help-doc.tpl, index-all.tpl, index-letter.tpl, overview.tpl, package-use.tpl, package.tpl, serialized-form.tpl
Calls:
about.tpl
This template adds the About section at the bottom of each separate output document. It displays the information about FlexDoc/Javadoc product along with the hyperlinks to this website.
Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/frgm/about.tpl
Controlled By Parameter:
Called From:
demo-incomplete.tpl
This template is used only during the demo mode, when the demo limits have been exceeded, to insert in the generated documentation the messages about that.Template Location:
-
{flexdoc-javadoc}/templates/classic/lib/frgm/demo-incomplete.tpl
Called From: