Class sun.tools.javadoc.MemberDoc
java.lang.Object
|
+----sun.tools.javadoc.Doc
|
+----sun.tools.javadoc.ProgramElementDoc
|
+----sun.tools.javadoc.MemberDoc
- Subclasses:
- ExecutableMemberDoc, FieldDoc
- public abstract class MemberDoc
- extends ProgramElementDoc
Represents a member of a java class: field, constructor, or method.
This is an abstract class dealing with information common to
method, constructor and field members. Class members of a class
(innerclasses) are represented instead by ClassDoc.
- See Also:
- MethodDoc, FieldDoc, ClassDoc
Method Summary
|
PackageDoc
|
containingPackage()
Return the package that this member is contained in.
|
boolean
|
isIncluded()
return true if this member is include in the active set.
|
java.lang.String
|
name()
Get the name.
|
java.lang.String
|
qualifiedName()
Get the name.
|
java.lang.String
|
toString()
Returns a string representation of the member.
|
Methods inherited from class sun.tools.javadoc.Doc
|
commentText, compareTo, getRawCommentText, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags, toString |
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
qualifiedName
public java.lang.String qualifiedName()
- Get the name.
- Returns:
- the qualified name of the member.
name
public java.lang.String name()
- Get the name.
- Returns:
- the unqualified name of the member.
- Overrides:
- name in class Doc
containingPackage
public PackageDoc containingPackage()
- Return the package that this member is contained in.
Return "" if in empty package.
isIncluded
public boolean isIncluded()
- return true if this member is include in the active set.
- Overrides:
- isIncluded in class Doc
toString
public java.lang.String toString()
- Returns a string representation of the member.
- Returns:
- a description of the member
- Overrides:
- toString in class Doc