Contents
| Package | Class |
Tree
|
Index
PREV | NEXT
SHOW LISTS
|
HIDE LISTS
A
C
D
E
F
G
I
K
M
N
O
P
Q
R
S
T
A
allClasses
(). Method in class sun.tools.javadoc.
PackageDoc
Get all classes (including Exceptions and Errors) and interfaces.
asClassDoc
(). Method in class sun.tools.javadoc.
ClassDoc
Return this type as a class.
asClassDoc
(). Method in interface sun.tools.javadoc.
Type
Return this type as a class.
C
ClassDoc
class sun.tools.javadoc.
ClassDoc
.
Represents a java class.
ConstructorDoc
class sun.tools.javadoc.
ConstructorDoc
.
Represents a constructor of a java class.
classNamed
(String). Method in class sun.tools.javadoc.
Root
Return a ClassDoc for the specified class/interface name
classes
(). Method in class sun.tools.javadoc.
Root
classes and interfaces to be documented.
commentText
(). Method in class sun.tools.javadoc.
Doc
Return the text of the comment for this doc item.
compareTo
(Object). Method in class sun.tools.javadoc.
Doc
Compares this Object with the specified Object for order.
constructors
(). Method in class sun.tools.javadoc.
ClassDoc
Return constructors in class.
containingClass
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Get the containing class of this program element.
containingPackage
(). Method in class sun.tools.javadoc.
MemberDoc
Return the package that this member is contained in.
containingPackage
(). Method in class sun.tools.javadoc.
ClassDoc
Return the package that this class is contained in.
D
Doc
class sun.tools.javadoc.
Doc
.
abstract base class of all Doc classes.
Doclet
class sun.tools.javadoc.
Doclet
.
This class documents the methods in a Doclet.
Doclet
(). Constructor for class sun.tools.javadoc.
Doclet
dimension
(). Method in class sun.tools.javadoc.
ClassDoc
Return the type's dimension information, as a string.
dimension
(). Method in interface sun.tools.javadoc.
Type
Return the type's dimension information, as a string.
E
ExecutableMemberDoc
class sun.tools.javadoc.
ExecutableMemberDoc
.
Represents a method or constructor of a java class.
errors
(). Method in class sun.tools.javadoc.
PackageDoc
Get Error classes in this package.
exception
(). Method in class sun.tools.javadoc.
ThrowsTag
Return the exception as a ClassDoc.
exceptionComment
(). Method in class sun.tools.javadoc.
ThrowsTag
Return the exception comment.
exceptionName
(). Method in class sun.tools.javadoc.
ThrowsTag
Return the exception name.
exceptions
(). Method in class sun.tools.javadoc.
PackageDoc
Get Exception classes in this package.
F
FieldDoc
class sun.tools.javadoc.
FieldDoc
.
Represents a field in a java class.
fields
(). Method in class sun.tools.javadoc.
ClassDoc
Return fields in class.
findClass
(String). Method in class sun.tools.javadoc.
ClassDoc
Find a class within the context of this class.
findField
(String). Method in class sun.tools.javadoc.
ClassDoc
Find a field in this class.
findMethod
(String). Method in class sun.tools.javadoc.
ClassDoc
Find a method in this class.
flatSignature
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
get flat signature.
G
getRawCommentText
(). Method in class sun.tools.javadoc.
Doc
Return the full unprocessed text of the comment.
I
implementedInterfaces
(). Method in class sun.tools.javadoc.
ClassDoc
Return interfaces which this class implements.
importedClasses
(). Method in class sun.tools.javadoc.
ClassDoc
Get the list of classes declared as imported.
importedPackages
(). Method in class sun.tools.javadoc.
ClassDoc
Get the list of packages declared as imported.
innerClasses
(). Method in class sun.tools.javadoc.
ClassDoc
Return inner classes within this class.
interfaces
(). Method in class sun.tools.javadoc.
PackageDoc
Get Interfaces in this package.
isAbstract
(). Method in class sun.tools.javadoc.
ClassDoc
Return true if this class is abstract
isAbstract
(). Method in class sun.tools.javadoc.
MethodDoc
Return true if this method is abstract
isClass
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a class.
isClass
(). Method in class sun.tools.javadoc.
ClassDoc
return true if this is a class (that is, not interface).
isConstructor
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a constructor? False until overridden.
isConstructor
(). Method in class sun.tools.javadoc.
ConstructorDoc
Return true if it is a constructor, which it is.
isError
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a error class? False until overridden.
isError
(). Method in class sun.tools.javadoc.
ClassDoc
Return true if this is an error class
isException
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a exception class? False until overridden.
isException
(). Method in class sun.tools.javadoc.
ClassDoc
Return true if this is an exception class
isField
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a field? False until overridden.
isField
(). Method in class sun.tools.javadoc.
FieldDoc
Is this Doc item a field?
isFinal
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Return true if this program element is final
isIncluded
(). Method in class sun.tools.javadoc.
Doc
return true if this Doc is include in the active set.
isIncluded
(). Method in class sun.tools.javadoc.
MemberDoc
return true if this member is include in the active set.
isIncluded
(). Method in class sun.tools.javadoc.
PackageDoc
return true if this package is include in the active set.
isIncluded
(). Method in class sun.tools.javadoc.
ClassDoc
return true if this class is include in the active set.
isIncluded
(). Method in class sun.tools.javadoc.
Root
return true if this Doc is include in the active set.
isInterface
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a interface? False until overridden.
isInterface
(). Method in class sun.tools.javadoc.
ClassDoc
Return true if this is an interface.
isMethod
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a simple method (i.e.
isMethod
(). Method in class sun.tools.javadoc.
MethodDoc
Return true if it is a method, which it is.
isNative
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Return true if this method is native
isOrdinaryClass
(). Method in class sun.tools.javadoc.
Doc
Is this Doc item a ordinary class (i.e.
isOrdinaryClass
(). Method in class sun.tools.javadoc.
ClassDoc
return true if this is a ordinary class (that is, not an exception, error or interface).
isPackagePrivate
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Return true if this program element is package private
isPrivate
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Return true if this program element is private
isProtected
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Return true if this program element is protected
isPublic
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Return true if this program element is public
isStatic
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Return true if this program element is static
isSynchronized
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Return true if this method is synchronized
isTransient
(). Method in class sun.tools.javadoc.
FieldDoc
Return true if this field is transient
isVolatile
(). Method in class sun.tools.javadoc.
FieldDoc
Return true if this field is volatile
K
kind
(). Method in class sun.tools.javadoc.
Tag
Return the kind of this tag.
kind
(). Method in class sun.tools.javadoc.
ThrowsTag
Return the kind of this tag.
kind
(). Method in class sun.tools.javadoc.
ParamTag
Return the kind of this tag.
kind
(). Method in class sun.tools.javadoc.
SeeTag
Return the kind of this tag.
M
MemberDoc
class sun.tools.javadoc.
MemberDoc
.
Represents a member of a java class: field, constructor, or method.
MethodDoc
class sun.tools.javadoc.
MethodDoc
.
Represents a method of a java class.
methods
(). Method in class sun.tools.javadoc.
ClassDoc
Return methods in class.
modifierSpecifier
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Get the modifier specifier integer.
modifiers
(). Method in class sun.tools.javadoc.
ProgramElementDoc
Get modifiers string.
N
name
(). Method in class sun.tools.javadoc.
Doc
Returns the name of this Doc item.
name
(). Method in class sun.tools.javadoc.
MemberDoc
Get the name.
name
(). Method in class sun.tools.javadoc.
PackageDoc
Get package name.
name
(). Method in class sun.tools.javadoc.
Tag
Return the name of this tag.
name
(). Method in class sun.tools.javadoc.
Parameter
Get local name of this parameter.
name
(). Method in class sun.tools.javadoc.
ConstructorDoc
Get the name.
name
(). Method in class sun.tools.javadoc.
ClassDoc
Return, as a string, the class name without qualifier.
name
(). Method in class sun.tools.javadoc.
Root
Return the name of this Doc item.
name
(). Method in interface sun.tools.javadoc.
Type
Return unqualified name of type excluding any dimension information.
O
optionLength
(String). Static method in class sun.tools.javadoc.
Doclet
Check for doclet added options here.
options
(). Method in class sun.tools.javadoc.
Root
Command line options.
ordinaryClasses
(). Method in class sun.tools.javadoc.
PackageDoc
Get ordinary classes (excluding Exceptions and Errors) in this package.
overridenClass
(Env, MemberDefinition). Method in class sun.tools.javadoc.
MethodDoc
Constructor assist Return the class that overrides this method.
overridenClass
(). Method in class sun.tools.javadoc.
MethodDoc
Return the class that overrides this method.
P
PackageDoc
class sun.tools.javadoc.
PackageDoc
.
Represents a java package.
PackageDoc
(String). Method in class sun.tools.javadoc.
Root
Return a PackageDoc for the specified class/interface name
ParamTag
class sun.tools.javadoc.
ParamTag
.
Represents an @param documentation tag.
Parameter
class sun.tools.javadoc.
Parameter
.
Parameter information.
ProgramElementDoc
class sun.tools.javadoc.
ProgramElementDoc
.
Represents a java program element: class, interface, field, constructor, or method.
paramTags
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Return the param tags in this method.
parameterComment
(). Method in class sun.tools.javadoc.
ParamTag
Return the parameter comment.
parameterName
(). Method in class sun.tools.javadoc.
ParamTag
Return the parameter name.
parameters
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Get argument information.
printError
(String). Static method in class sun.tools.javadoc.
Root
Print error message, increment error count.
printNotice
(String). Static method in class sun.tools.javadoc.
Root
Print a message.
printWarning
(String). Static method in class sun.tools.javadoc.
Root
Print warning message, increment warning count.
Q
qualifiedName
(). Method in class sun.tools.javadoc.
MemberDoc
Get the name.
qualifiedName
(). Method in class sun.tools.javadoc.
ConstructorDoc
Get the name.
qualifiedName
(). Method in class sun.tools.javadoc.
ClassDoc
Return, as a string, the qualified class name.
qualifiedName
(). Method in interface sun.tools.javadoc.
Type
Return qualified name of type excluding any dimension information.
R
Root
class sun.tools.javadoc.
Root
.
This class holds the information from one run of javadoc.
referencedClass
(). Method in class sun.tools.javadoc.
SeeTag
get the class referenced by the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .
referencedClassName
(). Method in class sun.tools.javadoc.
SeeTag
get the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .
referencedMember
(). Method in class sun.tools.javadoc.
SeeTag
get the member referenced by the prototype part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .
referencedMemberName
(). Method in class sun.tools.javadoc.
SeeTag
get the name of the member referenced by the prototype part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .
returnType
(). Method in class sun.tools.javadoc.
MethodDoc
Get return type.
S
SeeTag
class sun.tools.javadoc.
SeeTag
.
Represents a see also documentation tag.
seeTags
(). Method in class sun.tools.javadoc.
Doc
Return the see also tags in this Doc item.
setRawCommentText
(String). Method in class sun.tools.javadoc.
Doc
Set the full unprocessed text of the comment.
signature
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Get the signature.
specifiedClasses
(). Method in class sun.tools.javadoc.
Root
classes and interfaces specified on the command line.
specifiedPackages
(). Method in class sun.tools.javadoc.
Root
packages specified on the command line.
start
(Root). Static method in class sun.tools.javadoc.
Doclet
Generate documentation here.
subclassOf
(ClassDoc). Method in class sun.tools.javadoc.
ClassDoc
Test whether this class is a subclass of the specified class.
superclass
(). Method in class sun.tools.javadoc.
ClassDoc
Return the superclass of this class
T
Tag
class sun.tools.javadoc.
Tag
.
Represents a documentation tag, e.g.
ThrowsTag
class sun.tools.javadoc.
ThrowsTag
.
Represents a @throws or @exception documentation tag.
Type
interface sun.tools.javadoc.
Type
.
Represents a java type.
tags
(). Method in class sun.tools.javadoc.
Doc
Return all tags in this Doc item.
tags
(String). Method in class sun.tools.javadoc.
Doc
Return tags of the specified kind in this Doc item.
text
(). Method in class sun.tools.javadoc.
Tag
Return the text of this tag, that is, portion beyond tag name.
thrownExceptions
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Return exceptions this method or constructor throws.
throwsTags
(). Method in class sun.tools.javadoc.
ExecutableMemberDoc
Return the throws tags in this method.
toString
(). Method in class sun.tools.javadoc.
Doc
Returns a string representation of this Doc item.
toString
(). Method in class sun.tools.javadoc.
MemberDoc
Returns a string representation of the member.
toString
(). Method in class sun.tools.javadoc.
PackageDoc
Returns a string representation of the package.
toString
(). Method in class sun.tools.javadoc.
Tag
convert this object to a string.
toString
(). Method in class sun.tools.javadoc.
Parameter
Returns a string representation of the class.
toString
(). Method in class sun.tools.javadoc.
ClassDoc
Returns a string representation of the class.
toString
(). Method in class sun.tools.javadoc.
ParamTag
convert this object to a string.
toString
(). Method in interface sun.tools.javadoc.
Type
Returns a string representation of the type.
type
(). Method in class sun.tools.javadoc.
Parameter
Get the type of this parameter.
type
(). Method in class sun.tools.javadoc.
FieldDoc
Get type of this field.
typeName
(). Method in class sun.tools.javadoc.
Parameter
Get type name of this parameter.
A
C
D
E
F
G
I
K
M
N
O
P
Q
R
S
T
Contents
| Package | Class |
Tree
|
Index
PREV | NEXT
SHOW LISTS
|
HIDE LISTS