A B C D G H I L M P R S T X

A

anchor(String, String) - Static method in class de.h2b.taglets.HtmlUtil
Produces an HTML anchor with given name around a text.

B

BiblioTaglet - Class in de.h2b.taglets.biblets
A block taglet for typesetting bibliograhical items.
BiblioTaglet() - Constructor for class de.h2b.taglets.biblets.BiblioTaglet
Creates this taglet.
BlockTaglet - Class in de.h2b.taglets
An abstract class that represents a Javadoc block taglet.
BlockTaglet() - Constructor for class de.h2b.taglets.BlockTaglet
 

C

CiteTaglet - Class in de.h2b.taglets.biblets
An inline taglet for citing bibliographical items.
CiteTaglet() - Constructor for class de.h2b.taglets.biblets.CiteTaglet
Creates this taglet.
ClassLabel - Annotation Type in de.h2b.basis
An annotation type for putting certain information into a class file.
CrossRefMap - Class in de.h2b.taglets
A singleton that provides for a unique map of CrossRefTables.
CrossRefTable - Class in de.h2b.taglets
A helper class that provides for a general cross-referencing mechanism.
CrossRefTable() - Constructor for class de.h2b.taglets.CrossRefTable
Creates an empty table.
CrossRefTable(String) - Constructor for class de.h2b.taglets.CrossRefTable
Creates a table from an auxiliary file.

D

de.h2b.basis - package de.h2b.basis
Provides an auxiliary class.
de.h2b.taglets - package de.h2b.taglets
Provides for classes supporting the Javadoc taglets of this project.
de.h2b.taglets.biblets - package de.h2b.taglets.biblets
Provides for bibliographies in Javadoc typesetting.
de.h2b.taglets.mathlets - package de.h2b.taglets.mathlets
Provides for mathematical-formula support in Javadoc typesetting.
de.h2b.taglets.reflets - package de.h2b.taglets.reflets
Provides for numerical referencing in Javadoc typesetting.

G

getIndex(String) - Method in class de.h2b.taglets.CrossRefTable
Returns the index associated to a given key in the cross-ref table.
getInstance() - Static method in class de.h2b.taglets.CrossRefMap
Returns the only instance of this singleton.
getName() - Method in class de.h2b.taglets.biblets.BiblioTaglet
 
getName() - Method in class de.h2b.taglets.biblets.CiteTaglet
 
getName() - Method in class de.h2b.taglets.BlockTaglet
Returns the name of this custom tag.
getName() - Method in class de.h2b.taglets.InlineTaglet
Returns the name of this custom tag.
getName() - Method in class de.h2b.taglets.mathlets.MathTaglet
 
getName() - Method in class de.h2b.taglets.reflets.LabelTaglet
 
getName() - Method in class de.h2b.taglets.reflets.RefTaglet
 
getReference(String) - Method in class de.h2b.taglets.CrossRefTable
Returns the index associated to a given key in the cross-ref table.
getTable(String) - Method in class de.h2b.taglets.CrossRefMap
Returns the cross-ref table associated to a given key.
getTable(String, String) - Method in class de.h2b.taglets.CrossRefMap
Returns the cross-ref table associated to a given key.

H

href(String, String) - Static method in class de.h2b.taglets.HtmlUtil
Produces a local HTML reference to an anchor with given name around a text.
HtmlUtil - Class in de.h2b.taglets
A utility class that provides some static methods to produce certain HTML output.

I

inConstructor() - Method in class de.h2b.taglets.BlockTaglet
Will return true since it can be used in constructor documentation.
inConstructor() - Method in class de.h2b.taglets.InlineTaglet
Will return false since it is an inline tag.
inField() - Method in class de.h2b.taglets.BlockTaglet
Will return true since it can be used in field documentation.
inField() - Method in class de.h2b.taglets.InlineTaglet
Will return false since it is an inline tag.
InlineTaglet - Class in de.h2b.taglets
An abstract class that represents a Javadoc inline taglet.
InlineTaglet() - Constructor for class de.h2b.taglets.InlineTaglet
 
inMethod() - Method in class de.h2b.taglets.BlockTaglet
Will return true since it can be used in method documentation.
inMethod() - Method in class de.h2b.taglets.InlineTaglet
Will return false since it is an inline tag.
inOverview() - Method in class de.h2b.taglets.BlockTaglet
Will return true since it can be used in overview documentation.
inOverview() - Method in class de.h2b.taglets.InlineTaglet
Will return false since it is an inline tag.
inPackage() - Method in class de.h2b.taglets.BlockTaglet
Will return true since it can be used in package documentation.
inPackage() - Method in class de.h2b.taglets.InlineTaglet
Will return false since it is an inline tag.
inType() - Method in class de.h2b.taglets.BlockTaglet
Will return true since it can be used in type documentation (classes or interfaces).
inType() - Method in class de.h2b.taglets.InlineTaglet
Will return false since it is an inline tag.
isInlineTag() - Method in class de.h2b.taglets.BlockTaglet
Will return false since it is not an inline tag.
isInlineTag() - Method in class de.h2b.taglets.InlineTaglet
Will return true since it is an inline tag.

L

LabelTaglet - Class in de.h2b.taglets.reflets
An inline taglet for numerical referencing.
LabelTaglet() - Constructor for class de.h2b.taglets.reflets.LabelTaglet
Creates this taglet.
load(File) - Method in class de.h2b.taglets.CrossRefMap
Loads the map from a file.

M

MathTaglet - Class in de.h2b.taglets.mathlets
An inline taglet for typesetting mathematical formulas.
MathTaglet() - Constructor for class de.h2b.taglets.mathlets.MathTaglet
Creates this taglet.

P

PREFIX_FILE - Static variable in class de.h2b.taglets.mathlets.MathTaglet
Indicates file processing.
PREFIX_MATHML - Static variable in class de.h2b.taglets.mathlets.MathTaglet
Indicates MathML processing.

R

RefTaglet - Class in de.h2b.taglets.reflets
An inline taglet for numerical referencing.
RefTaglet() - Constructor for class de.h2b.taglets.reflets.RefTaglet
Creates this taglet.
register(Map) - Static method in class de.h2b.taglets.biblets.BiblioTaglet
Deprecated. Use central registration of Registration instead.
register(Map) - Static method in class de.h2b.taglets.biblets.CiteTaglet
Deprecated. Use central registration of Registration instead.
register(Map) - Static method in class de.h2b.taglets.mathlets.MathTaglet
Deprecated. Use central registration of Registration instead.
register(Map) - Static method in class de.h2b.taglets.reflets.LabelTaglet
Deprecated. Use central registration of Registration instead.
register(Map) - Static method in class de.h2b.taglets.reflets.RefTaglet
Deprecated. Use central registration of Registration instead.
register(Map) - Static method in class de.h2b.taglets.Registration
Registers all taglets of this project.
register(Map, Taglet) - Static method in class de.h2b.taglets.Registration
Registers a taglet.
Registration - Class in de.h2b.taglets
A singleton that provides a static register method as a single entry point for the javadoc tool.
run() - Method in class de.h2b.taglets.Registration
Serves as entry point for Runnable interface.

S

save(File) - Method in class de.h2b.taglets.CrossRefMap
Saves the map to a file.
save() - Method in class de.h2b.taglets.CrossRefTable
Saves the table to the auxiliary file.
SUBDIR_MATHML - Static variable in class de.h2b.taglets.mathlets.MathTaglet
Name of subdirectory for generated MathML files.

T

toString(Tag) - Method in class de.h2b.taglets.biblets.BiblioTaglet
Returns the processed text of the tag.
toString(Tag[]) - Method in class de.h2b.taglets.biblets.BiblioTaglet
Returns the processed text of multiple tags.
toString(Tag) - Method in class de.h2b.taglets.biblets.CiteTaglet
Returns the processed text of the tag.
toString(Tag) - Method in class de.h2b.taglets.BlockTaglet
Given the Tag representation of this custom tag, return its string representation.
toString(Tag[]) - Method in class de.h2b.taglets.BlockTaglet
Given an array of Tags representing this custom tag, return its string representation.
toString(Tag) - Method in class de.h2b.taglets.InlineTaglet
Given the Tag representation of this custom tag, return its string representation.
toString(Tag[]) - Method in class de.h2b.taglets.InlineTaglet
This method should not be called since arrays of inline tags do not exist.
toString(Tag) - Method in class de.h2b.taglets.mathlets.MathTaglet
Returns the processed text of the tag.
toString(Tag) - Method in class de.h2b.taglets.reflets.LabelTaglet
Returns the processed text of the tag.
toString(Tag) - Method in class de.h2b.taglets.reflets.RefTaglet
Returns the processed text of the tag.

X

XREF_MAP - Static variable in class de.h2b.taglets.Registration
The map that stores the cross-ref tables.
XREF_MAP_FILE - Static variable in class de.h2b.taglets.Registration
The file that stores the cross-ref map.

A B C D G H I L M P R S T X

Copyright © 2008 Hans-Hermann Bode, Berlin, Germany. All Rights Reserved.