org.umlgraph.doclet

Class WrappedRootDoc

java.lang.Object

org.umlgraph.doclet.WrappedRootDoc

public class WrappedRootDoc
extends java.lang.Object

RootDoc wrapper that provides WrappedClassDoc instances instead of plain ClassDoc in order to optimize the overall performance of UMLDoc.

Constructor Summary

Constructors

Constructor and Description
WrappedRootDoc(RootDoc wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
ClassDoc[]	classes()
ClassDoc	classNamed(java.lang.String arg0)
java.lang.String	commentText()
int	compareTo(java.lang.Object arg0)
Tag[]	firstSentenceTags()
java.lang.String	getRawCommentText()
Tag[]	inlineTags()
boolean	isAnnotationType()
boolean	isAnnotationTypeElement()
boolean	isClass()
boolean	isConstructor()
boolean	isEnum()
boolean	isEnumConstant()
boolean	isError()
boolean	isException()
boolean	isField()
boolean	isIncluded()
boolean	isInterface()
boolean	isMethod()
boolean	isOrdinaryClass()
java.lang.String	name()
java.lang.String[][]	options()
PackageDoc	packageNamed(java.lang.String arg0)
SourcePosition	position()
void	printError(SourcePosition arg0, java.lang.String arg1)
void	printError(java.lang.String arg0)
void	printNotice(SourcePosition arg0, java.lang.String arg1)
void	printNotice(java.lang.String arg0)
void	printWarning(SourcePosition arg0, java.lang.String arg1)
void	printWarning(java.lang.String arg0)
SeeTag[]	seeTags()
void	setRawCommentText(java.lang.String arg0)
ClassDoc[]	specifiedClasses()
PackageDoc[]	specifiedPackages()
Tag[]	tags()
Tag[]	tags(java.lang.String arg0)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WrappedRootDoc

public WrappedRootDoc(RootDoc wrapped)

Method Detail

classes

public ClassDoc[] classes()

classNamed

public ClassDoc classNamed(java.lang.String arg0)

commentText

public java.lang.String commentText()

compareTo

public int compareTo(java.lang.Object arg0)

firstSentenceTags

public Tag[] firstSentenceTags()

getRawCommentText

public java.lang.String getRawCommentText()

inlineTags

public Tag[] inlineTags()

isAnnotationType

public boolean isAnnotationType()

isAnnotationTypeElement

public boolean isAnnotationTypeElement()

isClass

public boolean isClass()

isConstructor

public boolean isConstructor()

isEnum

public boolean isEnum()

isEnumConstant

public boolean isEnumConstant()

isError

public boolean isError()

isException

public boolean isException()

isField

public boolean isField()

isIncluded

public boolean isIncluded()

isInterface

public boolean isInterface()

isMethod

public boolean isMethod()

isOrdinaryClass

public boolean isOrdinaryClass()

name

public java.lang.String name()

options

public java.lang.String[][] options()

packageNamed

public PackageDoc packageNamed(java.lang.String arg0)

position

public SourcePosition position()

printError

public void printError(SourcePosition arg0,
              java.lang.String arg1)

printError

public void printError(java.lang.String arg0)

printNotice

public void printNotice(SourcePosition arg0,
               java.lang.String arg1)

printNotice

public void printNotice(java.lang.String arg0)

printWarning

public void printWarning(SourcePosition arg0,
                java.lang.String arg1)

printWarning

public void printWarning(java.lang.String arg0)

seeTags

public SeeTag[] seeTags()

setRawCommentText

public void setRawCommentText(java.lang.String arg0)

specifiedClasses

public ClassDoc[] specifiedClasses()

specifiedPackages

public PackageDoc[] specifiedPackages()

tags

public Tag[] tags()

tags

public Tag[] tags(java.lang.String arg0)