Using it, you can generate:
'templates/javadoc/'
directory of the
DocFlex/Javadoc installation.
'templates/javadoc/lib/'
directory of the DocFlex/Javadoc installation.
Template | Description | Called From |
---|---|---|
PlainDoc.tpl | generates single-file documentation in any of the supported formats (HTML, RTF and TXT) | generator (doclet) |
FramedDoc.tpl | generates framed hypertext documentation (HTML only) | generator (doclet) |
Template | Description | Called From |
---|---|---|
init.tpl | creates element maps | PlainDoc.tpl, FramedDoc.tpl |
Subtemplates called to generate either big sections of single-file documentation or separate documents for the “detail” frame of framed HTML documentation | ||
overview-summary.tpl | generates the overview for the whole documentation | PlainDoc.tpl, FramedDoc.tpl |
package-summary.tpl | generates a package overview (i.e. description, tags and summary tables of contained classes) | PlainDoc.tpl, FramedDoc.tpl |
class.tpl | generates the detailed documentation for a class (i.e. class, interface, enum or annotation type) | PlainDoc.tpl, FramedDoc.tpl |
Subtemplates called to generate small fragments of the detailed documentation | ||
annotations.tpl | generates list of annotations (along with all related hyperlinks) of a package, class, member or constructor/method parameter | class.tpl, package-summary.tpl |
inline-tag.tpl | processes most of the inline tags | class.tpl, overview-summary.tpl, package-summary.tpl |
see-link.tpl | processes a user-defined cross-reference to related documentation | class.tpl, inline-tag.tpl, overview-summary.tpl, package-summary.tpl |
about.tpl | prints the “about” information at the bottom of most of documents | PlainDoc.tpl, class.tpl, overview-summary.tpl, package-summary.tpl |
Subtemplates that generate separate reference files used only in framed HTML documentation | ||
overview-frame.tpl | generates the reference document for the whole documentation | FramedDoc.tpl |
all-classes-frame.tpl | generates the reference document for all classes | FramedDoc.tpl |
package-frame.tpl | generates the reference document for a package | FramedDoc.tpl |
package-list.tpl |
generates the
package-list
text file
|
FramedDoc.tpl |
For further details, please see: DocFlex/Javadoc | Basic Templates | Parameters
exclude.byTags
),
which since v1.5.1 has been split into several ones.
Those parameters can be used to exclude from the generated documentation classes, fields and methods
with specified tags.
See the parameter description for more details.
Since version 1.5.2, to that was added a possibility to exclude everything by annotations.
See "Exclude by annotations"
parameter group
(exclude.byAnns.*
).
Annotations are more cumbersome to use for that purpose. But they can be retained in the compiled classes.
So the exclusion will work even when no corresponding Java source code is found on Javadoc source path.
Suppose, some time ago you modified the basic templates according to your needs and since then have been (happily) using them. Now, you come to this web-site and notice that the latest version of DocFlex/Javadoc supports a host of new features, which might be interesting to you too (for instance, the full support of Java 5.0).
Of course, you can run your old templates with the new DocFlex Doclet version. But this won't make those new features automatically available to you. First, they must be applied in templates, which are the actual programs that generate everything. (See About DocFlex/Javadoc | Key Features | Template-driven doclet architecture)
So, now you need to migrate to the new basic template set and copy to there or replicate all your specific changes necessary for your work. What is the best way to do this?
The safest way would be to replicate all your changes on the new templates.
You may try to mix your old templates with the new ones. But keep in mind that we constantly change something from the version to version.
Some subtemplates depend on other templates that call them. Basically, there are two such dependencies:
The basic template set is organized so that during the first steps each main template calls the init.tpl subtemplate, whose job is to create the element maps. All element maps are global. Further, they are used in many locations across the template set (especially, in class.tpl).
If the structure of some element maps is different from what is expected and used by a template, that template will work incorrectly (or not work at all)!
Note: |
Since v1.5.6, all basic templates
also include the version number of the DocFlex/Javadoc release to which the particular
template set belongs.
This may help you to quickly recognize if you have inadvertently mixed the templates
from different versions and because of this now experience errors and wrong working of
your template application.
You can find the version in the |