This section describes the predefined tags included in the default
configuration of the Taglets Collection.
It also gives an overview of the canned taglet classes that are suitable
for defining new tags from existing taglet classes.
Definition of a new custom tag is done by specifying the tag name
as well as its option in a configuration file.
Tag Definition
The following example shows the default definition of the @todo
block tag:
Taglets.taglet.todo= net.sourceforge.taglets.simple.block.ParamBlockTaglet
Taglets.taglet.todo.dl.class= tagletsTodo
Taglets.taglet.todo.dl.header= <b>Todo:</b>
Taglets.taglet.todo.before= impl
As you can see tags are introduced by using:
Taglets.taglet.<name>= <fully-qualified-implementation-class>
And options are added by using:
Taglets.taglet.<name>.option= value
The configuration can include any number of options. The options
are made available to the taglet under the name following the
tag name, e.g. to the @todo taglet listed above the
following options are "visible": dl.class,
dl.header, before.
Default Options
Similar to the tag ordering for
standard tags each taglet tag definition also "inherits"
the following ordering options:
Taglets.taglet.<name>.before= <next-tagname>
Taglets.taglet.<name>.after= <previous-tagname>
Taglets.tag.<name>.between= <previous-tagname>, <next-tagname>
Standard tags and custom taglet tags can be mixed in any order you like.
The following subsections list the tags included in the default
configuration of the Taglets Collection.
The links in the tag tables point to a sample use in the
Demo API Reference.
Tag Options
To configure the default tags please have a look at their default
configuration in file
/META-INF/taglets-default.properties
of your taglets.jar.
Have a look at the implementation
class and use the API documentation to see what configuration
options are available.
| Tag |
Description |
| @adm |
Prints general information about a source file.
Formates contents in form "$Revision$ $Date$"
to a nice listing consisting of Version and Maintainer
with complete revision information and a "mailto" link
to the maintainer (including preconfigured subject with all versioning
information).
Uses the following parameters params.maintainer.name,
params.maintainer.mail and params.maintainer.project.
|
| @constant |
Automagic constant value tag filler.
This tag need not be used in the JavaDoc, the taglet will
automagically insert the constant value of the field with
link to the constants overview HTML page.
If specified for a field no value will be generated but
the text of the tag is used without generating a link.
|
| @done |
Block tag for "Done" messages.
|
| @equivalence |
Block tag for "Equivalent To".
Preformatted and pretty-printed by default.
|
| @error |
Block tag for "Errors".
|
| @impl |
Block tag for "Implementation Notes".
|
| @info |
Block tag for "Informations".
|
| @new |
Block tag used for new revisions that have not yet been released.
When used in conjunction with the mandatory option of the
@since tags no warnings are issued for elements defining an
@new tag.
|
| @note |
Block tag for "Notes".
|
| @since |
Overrides the standard @since tag.
Behaves as the standard tag except that if option mandatory
is set to true warnings are printed for all @since
tags missing. (See also @new)
|
| @testcase |
Block tag for listings of "Testcases".
Preformatted and pretty-printed by default.
|
| @todo |
Block tag for "ToDo" messages.
|
| @adm |
Overrides the standard @version tag.
Behaves as the standard tag except if the contents is
$Revision$ $Date$
in this case the output is beautified.
Similar to @adm except that it does not generate
maintainer information.
|
| @warning |
Block tag for "Warnings".
|
| Tag |
Description |
| {@annotation} |
Used to include an annotation in an inline tag.
The same as {@at}.
|
| {@at} |
Used to escape the at sign '@' in inline tags.
The same as {@annotation}.
|
| {@example} |
Creates a sticky with the default title "Example".
Contents is generated in literal, preformatted mode.
|
| {@markupExample} |
Creates a sticky with the default title "Example".
Contents is generated in preformatted, but not literal mode.
|
| {@markupSource} |
Creates a box containing sourcecode,
does not have a title by default.
Contents is generated in literal, preformatted mode.
|
| {@source} |
Creates a box containing sourcecode,
does not have a title by default.
Contents is generated in preformatted, but not literal mode.
|
| {@stickyDone} |
Creates a sticky with the default title "Done".
|
| {@stickyError} |
Creates a sticky with the default title "Error".
|
| {@stickyInfo} |
Creates a sticky with the default title "Info".
|
| {@stickyNote} |
Creates a sticky with the default title "Note".
|
| {@stickyWarning} |
Creates a sticky with the default title "Warning".
|
| {@table} |
Creates an M*N table.
Has a header and fills available browser width by default.
|