Tag Reference for @xdoclet

Class Level Tags

@xdoclet.taghandler

Method Level Tags

Tag Usage, Class Level (@xdoclet)

These tags are used to generate Xdoclet module's xdoclet.xml files that is needed for a module to be slurped by xdoclet.

@xdoclet.taghandler (0..1)

Class tag to put on Tags Handler classes

Parameter Type Applicability Description Mandatory
namespace text Define the namespace (without XDt) for the tags handler. Example : PkTagsHandler have namespace="EjbPk" and the templates will look like true

Tag Usage, Method Level (@xdoclet)

These tags are used to generate Xdoclet module's xdoclet.xml files that is needed for a module to be slurped by xdoclet.

Tag Reference for @doc

Class Level Tags

Method Level Tags

@doc.tag

@doc.param

Tag Usage, Class Level (@doc)

These tags are used to generate the template tag documentation.

Tag Usage, Method Level (@doc)

These tags are used to generate the template tag documentation.

@doc.tag (0..1)

Indicates that the method implements a template tag.

Parameter Type Applicability Description Mandatory
type text Specifies whether it is a content or block type tag. true

@doc.param (0..1)

Describes a parameter of the template tag.

Parameter Type Applicability Description Mandatory
name text The name of the parameter. false
optional bool Whether the parameter is optional. Default is true. false
values text Comma-separated list of possible values the parameter can take. false
description text A description of the parameter. true

Tag Reference for @msg

Class Level Tags

@msg.bundle

Method Level Tags

Tag Usage, Class Level (@msg)

These tags are used to generate i18n message bundles

@msg.bundle (0..1)

Use on class level to customize generation of message bundles and translator classes.

Tag Usage, Method Level (@msg)

These tags are used to generate i18n message bundles