Index

Overview

Package

Class

Use

Tree

Index

Help

DocCheck 1.2 Beta 2

PREV NEXT

FRAMES NO FRAMES

A B C D E F G H I L M N O P Q R S T U V W

A

addLine(String) - Method in class com.sun.tools.doclets.doccheck.Form: Add a line of text.
address() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <ADDRESS> tag.
addressEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </ADDRESS> tag.
addTag(String, int) - Method in class com.sun.tools.doclets.doccheck.Form: Add a tag.
addTagSpacer() - Method in class com.sun.tools.doclets.doccheck.Form: Add a tag spacer.
aEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </A> tag.
aName(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print anchor <A NAME="name"> tag.
anchor(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print anchor <A NAME="name"> and </A>tags.
anchor(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print contents within anchor <A NAME="name"> tags.
append(String) - Method in class com.sun.tools.doclets.doccheck.Form: Append text to last line.
article(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the proper article (a or an) to go along with a word, depending on its first letter, plus a space.
author - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Name for @author tags.

B

badText(String) - Static method in class com.sun.tools.doclets.doccheck.Form: Return a string wrapped in the bad text color
badTextColor - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
blockquote() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <BLOCKQUOTE> tag.
blockquoteEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </BLOCKQUOTE> tag.
body() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <BODY> tag.
body(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <BODY BGCOLOR="bgcolor"> tag.
bodyEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </BODY> tag.
bold() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <B> tag.
bold(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print text passed, in bold format using <B> and </B> tags.
boldEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </B> tag.
br() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print newline and then print <BR> tag.
bSet_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used to start generated comments for boolean setFoo() methods
bVal_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used in generated comments for boolean values
byline(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck

C

categoryAnchor(int, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
categoryHeader(int, String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
center() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <CENTER> tag.
centerEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </CENTER> tag.
checkFirstSentence(String, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Check the first sentence for correctness.
checkHTML(String, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Check text for incomplete html tags.
checkTags(int, ClassDoc, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Check the tags for a class.
checkTags(int, ExecutableMemberDoc, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Check parameter tags for methods and constructors, plus then return tag for methods.
CLASS_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
CLASS_TAG - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
classlist - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: If true, tells the doclet to generate a file containing a list of classes that contain errors.
classListFile - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The name of the file to create when listing classes that have errors
classSkipList - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Classes to skip.
cnr_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used to start generated comments for constructors
code() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <CODE> tag.
codeEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </CODE> tag.
codeText(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter
com.sun.tools.doclets.doccheck - package com.sun.tools.doclets.doccheck
com.sun.tools.doclets.util - package com.sun.tools.doclets.util
commentEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print "-->" comment end string.
commentStart() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print "<!
compareTo(Object) - Method in class com.sun.tools.doclets.doccheck.DocCheck.HtmlTag
configFilename - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Configuration file.
CONSTR_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
contains - Variable in class com.sun.tools.doclets.util.Specifier

D

dat(int) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print numeric table data, right aligned.
dat(int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print numeric table data, right aligned.
dat(String) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print table data, right aligned.
dat(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print table data, right aligned.
datp(float) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print percentage table data, right aligned.
datp(float) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print percentage table data, right aligned.
datp(long) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print percentage table data, right aligned.
datp(long) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print percentage table data, right aligned.
dd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <DT> tag.
ddEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </DD> tag.
DEFAULT_CONSTR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
dl() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <DL> tag.
dlEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </DL> tag.
DocCheck - class com.sun.tools.doclets.doccheck.DocCheck.: Checks API specifications contained in Java source files.
DocCheck.HtmlTag - class com.sun.tools.doclets.doccheck.DocCheck.HtmlTag.: An inner class used to keep track of a tag and up to 60 characters that follow it.
DocCheck.ICheck - class com.sun.tools.doclets.doccheck.DocCheck.ICheck.: Inner class that checks to see if a method is implemented by an interface the class declares or inherits.
DocCheck.ParamTagData - class com.sun.tools.doclets.doccheck.DocCheck.ParamTagData.: An inner class that does the work of obtaining the information we need about a ParamTags.
DocCheck.ParamTagData(ParamTag) - Constructor for class com.sun.tools.doclets.doccheck.DocCheck.ParamTagData
DocCheck.ParamTagData(String, String) - Constructor for class com.sun.tools.doclets.doccheck.DocCheck.ParamTagData
DocCheck() - Constructor for class com.sun.tools.doclets.doccheck.DocCheck
DocCheckConstants - interface com.sun.tools.doclets.doccheck.DocCheckConstants.: Constants used in the doccheck app.
docletID - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: If true, tells the doclet to add a "Generated by" line to the summary page.
docletVersion - Static variable in class com.sun.tools.doclets.doccheck.DocCheck
dt() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <DT> tag.

E

echoUsage() - Static method in class com.sun.tools.doclets.util.PackageList: Delivers usage instructions when the program is invoked with no arguments.
em() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <EM> tag.
emEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </EM> tag.
end() - Method in class com.sun.tools.doclets.doccheck.Form: End of template
endDoc(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Finish the Html file.
endOfFirstSentence(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Return the index that identifies the end of the first sentence.
endsWith - Variable in class com.sun.tools.doclets.util.Specifier
eol - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Default line-terminator.
equals - Variable in class com.sun.tools.doclets.util.Specifier
ERR_CATEGORY_COUNT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
ERR_TYPE_COUNT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
errorFile - Static variable in class com.sun.tools.doclets.doccheck.DocCheck
EXC_EXTRA - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
EXC_INVALID - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
EXC_MISSING - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
EXC_TEXT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
execDepth - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The package depth for the executive summary page.
execSummary - Static variable in class com.sun.tools.doclets.doccheck.DocCheck
EXECUTABLE_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
explainClassPage(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
explainExecPage(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
explainPkgPage(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
explainPkgSummary(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
explainStatsPage(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck

F

FIELD_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
fileseparator - Static variable in class com.sun.tools.doclets.util.HtmlTagWriter: URL file separator string("/").
FileSpecifier - class com.sun.tools.doclets.util.FileSpecifier.: Filename specifier.
FileSpecifier(List) - Constructor for class com.sun.tools.doclets.util.FileSpecifier: Create a specifier using a pre-separated list of directory-name patterns.
FileSpecifier(List, String) - Constructor for class com.sun.tools.doclets.util.FileSpecifier: Create a specifier using a pre-separated list of directory-name patterns, specifying the separator that was used to break them apart.
FileSpecifier(String) - Constructor for class com.sun.tools.doclets.util.FileSpecifier: Create a specifier using the default directory-seperator for the current system, where the separator is used to divide the input string.
FileSpecifier(String, String) - Constructor for class com.sun.tools.doclets.util.FileSpecifier: Create a specifier using the specified directory-seperator, where the separator is used to divide the input string.
findPkgs(File, File) - Static method in class com.sun.tools.doclets.util.PackageList: Recursively searches a directory and returns a list of package names corresponding to directories that (a) contain .java or .class files and (b) are not in either of the "skip lists" specified on the command line.
firstLine(int, ClassDoc, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Adds the first line for a class comment.
firstLine(int, ConstructorDoc, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Adds the first line for a constructor.
firstLine(int, MethodDoc, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Adds the first line for the method comment.
font(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <FONT SIZE="size"> tag.
fontEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </FONT> tag.
fontSizeStyle(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <FONT SIZE="size" CLASS="stylename"> tag.
fontStyle(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <FONT CLASS="stylename"> tag.
Form - class com.sun.tools.doclets.doccheck.Form.: A class that builds a template for a JavaDoc comment that needs to be added or corrected.
Form() - Constructor for class com.sun.tools.doclets.doccheck.Form: Create a template-object

G

genWriter(String, String, String) - Static method in class com.sun.tools.doclets.util.HtmlTagWriter: Create the directory path for the file to be generated, construct FileOutputStream and OutputStreamWriter depending upon docencoding.
get_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used to start generated comments for getFoo() methods
getAuthor() - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the name used for @author tags.
getBold() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Get the "<B>" string.
getBoldEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Get the "</B>" string.
getCode() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Get the "<CODE>" string.
getCodeEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Get the "</CODE>" string.
getEOL() - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the EOL value.
getFontColor(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Get the "<FONT COLOR="color">" string.
getFontEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Get the "</FONT>" string.
getVersion() - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the version value.
groupList - Variable in class com.sun.tools.doclets.doccheck.DocCheck
groupName(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Return the name of the group that a package belongs to, as governed by the -execDepth setting.

H

h1() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <H1> tag.
h1(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print text with <H1> tag.
h1End() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </H1> tag.
h2() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <H2> tag.
h2(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print text with <H2> tag.
h2End() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </H2> tag.
h3() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <H3> tag.
h3(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print text with <H3> tag.
h3End() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </H3> tag.
h4() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <H4> tag.
h4(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print text with <H4> tag.
h4End() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </H4> tag.
h5() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <H5> tag.
h5End() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </H5> tag.
head() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <HEAD> tag.
headEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </HEAD> tag.
hr() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <HR> tag.
hr(int, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <HR SIZE="size" WIDTH="widthpercent%"> tag.
hr(int, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <HR SIZE="size" NOSHADE> tag.
HTML_BODY - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
HTML_ERROR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
HTML_EXTRA - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
HTML_FIRST - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
HTML_LIST - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
HTML_NO_PERIOD - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
HTML_UNCLOSED - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
html() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <HTML> tag.
htmlEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </HTML> tag.
htmlFilename - Variable in class com.sun.tools.doclets.util.HtmlTagWriter: Name of the file to which this writer is writing.
HtmlTagWriter - class com.sun.tools.doclets.util.HtmlTagWriter.: Class for the Html format code generation.
HtmlTagWriter(String, String) - Constructor for class com.sun.tools.doclets.util.HtmlTagWriter: Initializes PrintWriter with the FileWriter.
HtmlTagWriter(String, String, String) - Constructor for class com.sun.tools.doclets.util.HtmlTagWriter: Initializes PrintWriter with the FileWriter.
HtmlWriterExt - class com.sun.tools.doclets.doccheck.HtmlWriterExt.: An extension of HtmlWriter to add a alignable column-spanning method.
HtmlWriterExt(String, String) - Constructor for class com.sun.tools.doclets.doccheck.HtmlWriterExt

I

ifc_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used for generated interface comments.
IFC_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
img(String, String, int, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print HTML <IMG SRC="imggif" WIDTH="width" HEIGHT="height" ALT="imgname> tag.
IMPLEMENTS - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
implementsInterface(MethodDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck.ICheck: Checks to see if the method implements an interface.
initialText(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns first 20 characters of a string.
initPatternList(List) - Method in class com.sun.tools.doclets.util.PathSpecifier: Initialize the list of path patterns
initSpec(List) - Method in class com.sun.tools.doclets.util.FileSpecifier: Initialize this specifier
initUpper(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns true if the string starts with an uppercase letter.
INNER_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
INVALID_TAG - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
is_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used to start generated comments for isFoo() methods
italic() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <I> tag.
italicEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </I> tag.
italics(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print text passed, in Italics using <I> and </I> tags.
italicsText(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Return, text passed, with Italics <I> and </I> tags, surrounding it.

L

li() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <LI> tag.
li(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <LI TYPE="type"> tag.
link(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <LINK str> tag.
link(String, String) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print <a HREF="href"> text </a> tag.
link(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <a HREF="href"> text </a> tag.
listFile - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The file that gets the list of error-containing files.

M

main(String[]) - Static method in class com.sun.tools.doclets.util.PackageList: Recursively searches the list of directories specified on the command line and identifies Java packages.
mainFile - Static variable in class com.sun.tools.doclets.doccheck.DocCheck
MAJOR_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
majorErrs - Variable in class com.sun.tools.doclets.doccheck.DocCheck
makeWriter(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Create an HtmlTagWriter using the encoding-specification that JavaDoc so kindly left for us in the static Configuration class.
match(List) - Method in class com.sun.tools.doclets.util.PathSpecifier: Check the list of path-elements to see if it matches this specifier.
match(String) - Method in class com.sun.tools.doclets.util.Specifier: Return true if the argument is a match for this specifier.
match(String) - Method in class com.sun.tools.doclets.util.FileSpecifier: Check the string argument to see if it matches this specifier, where the default directory-seperator for the current system is used to divide the input string into directory-name segments.
match(String) - Method in class com.sun.tools.doclets.util.PathSpecifier: Check the string argument to see if it matches this specifier, where the default directory-seperator for the current system is used to divide the input string into directory-name segments.
match(String, String) - Method in class com.sun.tools.doclets.util.FileSpecifier: Check the string argument to see if it matches this specifier, where the specified seperator is used to divide the input string into directory-name segments.
match(String, String) - Method in class com.sun.tools.doclets.util.PathSpecifier: Check the string argument to see if it matches this specifier, where the specified seperator is used to divide the input string into directory-name segments.
MEMBER_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
menu() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <MENU> tag.
menuEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </MENU> tag.
METHOD_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
METHOD_TAG - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
methodExists(String, ExecutableMemberDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns true if the containing object has a method with the given name.
minIndex(int, int) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Return the minimum of two indexes if > -1, and return -1 only if both indexes = -1.
minorErrs - Variable in class com.sun.tools.doclets.doccheck.DocCheck
mkdir(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck

N

name(ClassDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Return a string containing the non-qualified class name that uses "$" to separate inner classes from outer classes instead of ".".
nameSpec - Variable in class com.sun.tools.doclets.util.FileSpecifier
namesToSkip - Static variable in class com.sun.tools.doclets.util.PackageList: A list of directory names to be skipped anywhere they appear in the hierarchy.
NO_COMMENT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
NO_EVIDENT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
NO_SINCE - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
NO_TEXT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
noErrs - Variable in class com.sun.tools.doclets.doccheck.DocCheck
noFrames() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <NOFRAMES> tag.
noFramesEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </NOFRAMES> tag.
NONE - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants

O

obj_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used for object-values in constructors
openEnded - Variable in class com.sun.tools.doclets.util.PathSpecifier: Set true when the pattern to match ends with "*", as in "java.awt.*".
optionLength(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the "length" of a given option.
outputDir - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The place where the list of error-containing classes (class.lst) will be created if the -classlist option is specified.
overrideMessage(int, MethodDoc, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Adds a line identifying the overridden method
OVERRIDES - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants

P

p() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print newline and then print <P> tag.
PackageList - class com.sun.tools.doclets.util.PackageList.: Generates a list of packages under the specified root directory(s).
PackageList() - Constructor for class com.sun.tools.doclets.util.PackageList
parameterComment() - Method in class com.sun.tools.doclets.doccheck.DocCheck.ParamTagData
parameterName() - Method in class com.sun.tools.doclets.doccheck.DocCheck.ParamTagData
paramPhrase(ExecutableMemberDoc, String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns an article (a or an) plus the string, depending on its initial letter (in the general case) or a somewhat more specialized version for booleans, ints, and arrays.
parse(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Breaks a string into component names.
parsePath(String) - Static method in class com.sun.tools.doclets.util.PathSpecifier: Divide the string argument into directory-name patterns using the default directory-seperator for the current system.
parsePath(String, String) - Static method in class com.sun.tools.doclets.util.PathSpecifier: Divide the string argument into directory-name patterns using the specified directory-seperator.
pathPrefix - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Used to point to the output directory.
pathSpec - Variable in class com.sun.tools.doclets.util.FileSpecifier
PathSpecifier - class com.sun.tools.doclets.util.PathSpecifier.: Path name specifier.
PathSpecifier(List) - Constructor for class com.sun.tools.doclets.util.PathSpecifier: Create a specifier using a pre-separated list of directory-name patterns.
PathSpecifier(List, String) - Constructor for class com.sun.tools.doclets.util.PathSpecifier: Create a specifier using a pre-separated list of directory-name patterns, plus the separator that was used to split them apart (for use when gluing them back together with toString().
PathSpecifier(String) - Constructor for class com.sun.tools.doclets.util.PathSpecifier: Create a specifier using the default directory-seperator for the current system, where the separator is used to divide the input string into directory-name patterns.
PathSpecifier(String, String) - Constructor for class com.sun.tools.doclets.util.PathSpecifier: Create a specifier using the specified directory-seperator, where the separator is used to divide the input string into directory-name patterns.
patternList - Variable in class com.sun.tools.doclets.util.PathSpecifier
PKG_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
pkgName(File, File) - Static method in class com.sun.tools.doclets.util.PackageList: Return the package name corresponding to the specified directory.
pkgSkipList - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Packages to skip.
pkgsToSkip - Static variable in class com.sun.tools.doclets.util.PackageList: A list of fully-qualified directory paths to be skipped.
pkgSummary - Static variable in class com.sun.tools.doclets.doccheck.DocCheck
pre() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <PRE> tag.
preEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </PRE> tag.
print(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.Form: Print the template.
printClassErrors(ErrorTracker, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Print errors for a class.
printClassPage(String, String, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck
printErrorPages() - Method in class com.sun.tools.doclets.doccheck.DocCheck
printExecutiveSummary() - Method in class com.sun.tools.doclets.doccheck.DocCheck
printIndexPage() - Method in class com.sun.tools.doclets.doccheck.DocCheck
printMemberErrors(int, String, ErrorTracker, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
printMemberTable(int, String, ErrorTracker, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
printPackageErrors() - Method in class com.sun.tools.doclets.doccheck.DocCheck
printPackagePage(PkgTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck
printPackageSummary() - Method in class com.sun.tools.doclets.doccheck.DocCheck
printPkgErrors(ErrorTracker, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Print errors for a package.
printStatisticsPage() - Method in class com.sun.tools.doclets.doccheck.DocCheck
processArgs(String[]) - Static method in class com.sun.tools.doclets.util.PackageList: Process the command line to
processClasses(ClassDoc[], boolean, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Process classes.
processConstructors(ConstructorDoc[], ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Process the constructors in a class.
processFields(FieldDoc[], ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Process the fields in the class.
processMethods(ClassDoc, MethodDoc[], ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Process the methods in a class.
processPackages(PackageDoc[]) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Process each package and the classes/interfaces within it.
propertyName(MethodDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the name of the property for methods with names like isFoo(), getFoo(), and setFoo().

Q

qualifiedName(ClassDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Return a string containing the qualified class name that uses "$" to separate inner classes from outer classes instead of ".".

R

reportErrors(SortedSet, ErrorTracker) - Method in class com.sun.tools.doclets.doccheck.DocCheck
RET_EXTRA - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
RET_INVALID - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
RET_MISSING - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
RET_TEXT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
returnPhrase(MethodDoc, String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns an article (a or an) plus the string, depending on its intitial letter and whether or not the type is an array.

S

SEE_INVALID - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
SEE_MISSING - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
SEE_TAG - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
SEE_TEXT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
SELF_EVIDENT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
selfEvidentCommentLevel - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The error level at which "self-evident comments are reported.
separator - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The directory-name seprator string.
set_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used to start generated comments for setFoo() methods
setAuthor(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Sets the string used for @author tags.
setClassSkipList(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Initialize the list of classes to skip.
setEOL(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Set the EOL value.
setPkgSkipList(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Initialize the list of packages to skip.
setTitle(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Set the title string.
setVersion(String) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: Set the version value.
signature(ConstructorDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the signature for a constructor.
signature(MethodDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns the signature for a method.
simpleName(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Remove the package prefix and array subscripts from a name.
singleTag - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: HTML tags that can be safely ignored, because they need no termination
space() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print " ", non-breaking space.
Specifier - class com.sun.tools.doclets.util.Specifier.: Foundation class for package and filename matching.
Specifier(String) - Constructor for class com.sun.tools.doclets.util.Specifier: Create a specifier object, supplying a pattern to match.
squashBlanks(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Compress multiple spaces down to one.
start() - Method in class com.sun.tools.doclets.doccheck.Form: Start of template
start(RootDoc) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: DocLet-mandated start method.
startDoc(String, String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Print the Html file header.
startGeneration(RootDoc) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Find errors and generate error messages for each package and class specified on the command line.
startsWith - Variable in class com.sun.tools.doclets.util.Specifier
stats4(int, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
stats4(int, int, int, int, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Print 4 numbers (ints)
stats4p(String, String, String, String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Print 4 percentages (longs)
statsFile - Static variable in class com.sun.tools.doclets.doccheck.DocCheck
statsRow(String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Start a statistics row
statsRowEnd(HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
statsTableHeader(String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
summaryTableHeader(String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck
sup() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <SUP> tag.
supEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </SUP> tag.

T

table() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print the HTML table tag with border size 0 and width 100%.
table(int, int, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print HTML <TABLE BORDER="border" CELLPADDING="cellpadding" CELLSPACING="cellspacing"> tag.
table(int, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print HTML <TABLE BORDER="border" WIDTH="width">
table(int, String, int, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print HTML <TABLE BORDER="border" WIDTH="width" CELLPADDING="cellpadding" CELLSPACING="cellspacing"> tag.
tableEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </TABLE> tag.
TAG_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
TAG_EXTRA - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
TAG_INVALID - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
TAG_MISSING - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
TAG_MULTVER - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
TAG_SPACER - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
TAG_TEXT - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
td() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD> tag.
tdAlign(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align"> tag.
tdAlignColspan(String, int) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print <TD ALIGN="align" COLSPAN=rowspan> tag.
tdAlignColspan(String, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align" COLSPAN=rowspan> tag.
tdAlignRowspan(String, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align" ROWSPAN=rowspan> tag.
tdAlignVAlign(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align" VALIGN="valign"> tag.
tdAlignVAlignRowspan(String, String, int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align" VALIGN="valign" ROWSPAN=rowspan> tag.
tdAlignValignWidth(String, String, String) - Method in class com.sun.tools.doclets.doccheck.HtmlWriterExt: Print <TD ALIGN="align" WIDTH="width"> tag.
tdAlignValignWidth(String, String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align" WIDTH="width"> tag.
tdBgcolorStyle(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD BGCOLOR="color" CLASS="stylename"> tag.
tdColspan(int) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD COLSPAN=i> tag.
tdColspanBgcolorStyle(int, String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD COLSPAN=i BGCOLOR="color" CLASS="stylename"> tag.
tdEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </TD> tag.
tdNowrap() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD NOWRAP> tag.
tdVAlign(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD VALIGN="valign"> tag.
tdVAlignClass(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD ALIGN="align" CLASS="stylename"> tag.
tdWidth(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TD WIDTH="width"> tag.
TEXT_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
title() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TITLE> tag.
titleEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </TITLE> tag.
today() - Method in class com.sun.tools.doclets.doccheck.DocCheck: Get the day and date information for today.
toString() - Method in class com.sun.tools.doclets.util.Specifier
toString() - Method in class com.sun.tools.doclets.util.FileSpecifier
toString() - Method in class com.sun.tools.doclets.util.PathSpecifier
totalErrors - Variable in class com.sun.tools.doclets.doccheck.DocCheck: The sum of all errors.
tr() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TR> tag.
trAlignVAlign(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TR ALIGN="align" VALIGN="valign"> tag.
trBgcolor(String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TR BGCOLOR="color"> tag.
trBgcolorStyle(String, String) - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <TR BGCOLOR="color" CLASS="stylename"> tag.
trEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </TR> tag.
TYPE_ERR - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
typePhrase(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns a plural phrase if the argument is an array, else returns a singular phrase.
typeTableHeader(String, HtmlTagWriter) - Method in class com.sun.tools.doclets.doccheck.DocCheck

U

ul() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print <UL> tag.
ulEnd() - Method in class com.sun.tools.doclets.util.HtmlTagWriter: Print </UL> tag.
uncap(String) - Method in class com.sun.tools.doclets.doccheck.DocCheck: Returns a properly capitalized name.

V

val_clause - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: The clause used to end generated comments for non-boolean values
validOptions(String[][], DocErrorReporter) - Static method in class com.sun.tools.doclets.doccheck.DocCheck: After parsing the available options using DocCheck.optionLength(java.lang.String), JavaDoc invokes this method with an array of options-arrays, where the first item in any array is the option, and subsequent items in that array are its arguments.
version - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: String for @version tags.
versionTitle - Static variable in class com.sun.tools.doclets.doccheck.DocCheck: Title line for report.

W

WARNING - Static variable in interface com.sun.tools.doclets.doccheck.DocCheckConstants
windowTitle - Variable in class com.sun.tools.doclets.doccheck.DocCheck

A B C D E F G H I L M N O P Q R S T U V W

Overview

Package

Class

Use

Tree

Index

Help

DocCheck 1.2 Beta 2

PREV NEXT

FRAMES NO FRAMES