Tag Reference for @xdoclet

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

Method Level Tags

Field Level Tags

Tag Usage, Class Level (@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 < XDtEjbPk:xxx/ > true

@xdoclet.merge-file (0..*)

Class tag to document a subtask's templates' merge points.

Parameter Type Applicability Description Mandatory
file text The filename pattern of the merge file. This will either be a simple filename (e.g. assembly-descriptor.xml) or a filename pattern (e.g. ejb-env-entries-{0}.xml) and should match the "file" parameter of the < XDtMerge:merge/ > tem plate tag. true
relates-to text The generated file to which a given merge point relates. Helps to clarify things if a given subtask generates a number of types of file (e.g. a deployment descriptor and a CMP mapping file) false
description text A description of what the merge point is used for, and what the merge file should contain. true

Tag Reference for @doc

These tags are used to generate the template tag documentation.

Class Level Tags

Method Level Tags

@doc.tag

@doc.param

Field Level Tags

Tag Usage, Method Level (@doc)

@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.
Valid options are:

block

content
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

These tags are used to generate i18n message bundles

Class Level Tags

@msg.bundle

Method Level Tags

Field Level Tags

@msg.message

Tag Usage, Class Level (@msg)

@msg.bundle (0..1)

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

Tag Usage, Field Level (@msg)

@msg.message (0..*)

Place this tag on static final string fields initialised with property key

Parameter Type Applicability Description Mandatory
msg text message itself true
language text Language code i.e "de", "en", "fr" false
country text Country code i.e. "DE", "US", "UK" false
variant text variant - have no example at this time. Somebody please provide it. false