Package

Implemented in class xdoclet.tagshandler.PackageTagsHandler.

Block Tags:

packageOf (block template)

Returns the not-full-qualified package name of the full-qualified class name specified in the body of this tag.

forAllPackages (block template)

Iterates over all packages loaded by javadoc. Subsequent calls to forAllClasses will only iterate over the classes in the current package.

[abstract] If true then accept abstract classes also; otherwise don't.

Valid Values = {true,false}
[type] For all classes by the type.

[extent] Specifies the extent of the type search. If concrete-type then only check the concrete type, if superclass then check also superclass, if hierarchy then search the whole hierarchy and find if the class is of the specified type. Default is hierarchy.

Valid Values = {concrete-type,superclass,hierarchy}

Content templates:

packageNameAsPathFor (content template)

Returns the current package name as path

packageNameAsPathFor (content template)

Returns the current package name as path

packageName (content template)

Returns the current package name. If we're in the context of a package iteration, this is the name of the current package. If we're in the context of a class iteration without a package iteration, return the name of the current class' package.

packageNameAsPath (content template)

Returns the current package name as path

getClassNameFor (content template)

Returns the not-full-qualified name of the current class without the package name.

getFullClassNameFor (content template)

Returns the full-qualified name of the current class with the package name.

getFullSuperclassNameFor (content template)

Returns the full-qualified name of the superclass of the current class.

setMatchValue (content template)

Sets the vaSoulue of match variable.

value The new value for matchPattern.

matchValue (content template)

Returns the value of match variable. Match variable serves as a variable for templates, you set it somewhere in template and look it up somewhere else in template.

currentToken (content template)

Returns current token inside forAllClassTagTokens.

skipToken (content template)

Skips current token. Returns empty string.