Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
A
C
D
G
H
I
L
O
P
R
S
T
A
allClassesRef
- Static variable in class
LatexDoclet
Holds the id of the panel listing all classes in the generated file
author
- Static variable in class
LatexDoclet
The document author - used on the title page.
C
classIds
- Static variable in class
LatexDoclet
This hashtable is used to match heading ids to fully qualified class names.
currentPackageId
- Static variable in class
LatexDoclet
Holds the link id of the package currently being processed
D
definitionListFirstLine
- Static variable in class
LatexDoclet
This flag is used when converting definition lists from html to latex.
dehyphenate(String)
- Static method in class
LatexDoclet
Prevents latex from hyphenating the words, by appending a mandatory hyphen point at the end of all the words in the string.
doc
- Static variable in class
LatexDoclet
This is the RootDoc object passed to the start method.
G
getClassId(ClassDoc)
- Static method in class
LatexDoclet
Gets the id for a given class.
getClassId(String)
- Static method in class
LatexDoclet
Gets the id for a given class.
getExceptionsString(ExecutableMemberDoc)
- Static method in class
LatexDoclet
Returns a string with a comma-separate list of all the exceptions that may be thrown by a method.
getLink(String, String)
- Static method in class
LatexDoclet
Gets Latex for reference to specified class.
getParamString(ExecutableMemberDoc)
- Static method in class
LatexDoclet
Returns a string containing all the parameters for a method.
H
header()
- Static method in class
LatexDoclet
Writes the latex header.
I
isPackageInternal(String)
- Static method in class
LatexDoclet
Determines if the specified package is one being processed in this file.
L
LatexDoclet
- class
LatexDoclet
.
This class is a doclet that generates Javadoc help as a LaTex file.
LatexDoclet()
- Constructor for class
LatexDoclet
O
optionLength(String)
- Static method in class
LatexDoclet
Returns how many option words specify a given tag.
ourPackages
- Static variable in class
LatexDoclet
An array of all the package names documented in the IPF being generated.
out
- Static variable in class
LatexDoclet
The output is written to this Writer.
outputFileName
- Static variable in class
LatexDoclet
The name of the output file.
P
packageListId
- Static variable in class
LatexDoclet
Holds the id of the panel with the list of all packages
printClassTree(ClassDoc)
- Static method in class
LatexDoclet
Outputs latex for superclass hierarchy for a class.
processClass(ClassDoc)
- Static method in class
LatexDoclet
Produces the latex for a particular class.
processCommentText(String, boolean)
- Static method in class
LatexDoclet
Process the comment or tag text to convert html tagging to Latex commands.
processConstructors(ConstructorDoc[], int)
- Static method in class
LatexDoclet
Write out a the constructor details.
processFields(FieldDoc[], int)
- Static method in class
LatexDoclet
Write out a field details.
processMethods(MethodDoc[], int)
- Static method in class
LatexDoclet
Write out the method details.
processPackage(PackageDoc, int)
- Static method in class
LatexDoclet
Processes an individual package.
processSymbols(String)
- Static method in class
LatexDoclet
This method is called to convert certain characters in a string to their symbolic representation in latex.
R
readOptions(String[][])
- Static method in class
LatexDoclet
Processes our extra command line options.
ref
- Static variable in class
LatexDoclet
This variable is incremented every time a heading id is specified, so that each heading id will be unique.
S
showDetails
- Static variable in class
LatexDoclet
Flag indicates whether to show the details of constructors, methods, and fields.
showSummary
- Static variable in class
LatexDoclet
Falg indicates whether to show the summaries of constructors, methods, and fields.
start(RootDoc)
- Static method in class
LatexDoclet
Called to start processing documentation.
T
title
- Static variable in class
LatexDoclet
The title to use for the latex file.
trailer()
- Static method in class
LatexDoclet
Writes the trailer for the latex file.
twoSide
- Static variable in class
LatexDoclet
Flag indicating whether document should be formatted for double-sided printing or not.
A
C
D
G
H
I
L
O
P
R
S
T
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES