com.go.beandoc.teadoc
Class Doc

java.lang.Object
  |
  +--com.go.beandoc.teadoc.Doc
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable
Direct Known Subclasses:
PackageDoc, ProgramElementDoc

public class Doc
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

Version:
6 , 8/23/00
Author:
Brian S O'Neill
See Also:
Serialized Form

Inner Class Summary
 class Doc.TagMap
           
 
Field Summary
protected  RootDoc mRootDoc
           
 
Constructor Summary
Doc(RootDoc root, com.sun.javadoc.Doc doc)
           
 
Method Summary
 int compareTo(java.lang.Object obj)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getCommentText()
           
 Tag[] getFirstSentenceTags()
           
 Tag[] getInlineTags()
           
 com.sun.javadoc.Doc getInnerDoc()
           
 java.lang.String getName()
           
 java.lang.String[] getPath()
           
 java.lang.String getRawCommentText()
           
 RootDoc getRootDoc()
           
 SeeTag[] getSeeTags()
           
 Doc.TagMap getTagMap()
           
 Tag[] getTags()
           
 java.lang.String getTagValue(java.lang.String tagName)
          Gets the text value of the first tag in doc that matches tagName
 boolean isClass()
           
 boolean isConstructor()
           
 boolean isError()
           
 boolean isException()
           
 boolean isField()
           
 boolean isIncluded()
           
 boolean isInterface()
           
 boolean isMethod()
           
 boolean isOrdinaryClass()
           
 boolean isTagPresent(java.lang.String tagName)
          Checks to see if the specified tag exists
protected  java.lang.String[] parseName(java.lang.String name)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mRootDoc

protected RootDoc mRootDoc
Constructor Detail

Doc

public Doc(RootDoc root,
           com.sun.javadoc.Doc doc)
Method Detail

parseName

protected java.lang.String[] parseName(java.lang.String name)

getInnerDoc

public com.sun.javadoc.Doc getInnerDoc()

getRootDoc

public RootDoc getRootDoc()

getCommentText

public java.lang.String getCommentText()

isTagPresent

public boolean isTagPresent(java.lang.String tagName)
Checks to see if the specified tag exists

getTagValue

public java.lang.String getTagValue(java.lang.String tagName)
Gets the text value of the first tag in doc that matches tagName

getTags

public Tag[] getTags()

getTagMap

public Doc.TagMap getTagMap()

getSeeTags

public SeeTag[] getSeeTags()

getInlineTags

public Tag[] getInlineTags()

getFirstSentenceTags

public Tag[] getFirstSentenceTags()

getRawCommentText

public java.lang.String getRawCommentText()

getName

public java.lang.String getName()

getPath

public java.lang.String[] getPath()

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable

isField

public boolean isField()

isMethod

public boolean isMethod()

isConstructor

public boolean isConstructor()

isInterface

public boolean isInterface()

isException

public boolean isException()

isError

public boolean isError()

isOrdinaryClass

public boolean isOrdinaryClass()

isClass

public boolean isClass()

isIncluded

public boolean isIncluded()

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object