|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
org.codehaus.groovy.tools.groovydoc.SimpleGroovyPackageDoc
public class SimpleGroovyPackageDoc
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
SimpleGroovyPackageDoc(String name)
|
|
| Method Summary | |
|---|---|
GroovyClassDoc[] |
allClasses()
All included classes and interfaces in this package. |
GroovyClassDoc[] |
allClasses(boolean arg0)
All classes and interfaces in this package optionally limited to just the included ones. |
String |
description()
Description of the package. |
GroovyClassDoc[] |
enums()
Included enum types in this package. |
GroovyClassDoc[] |
errors()
Included errors in this package. |
GroovyClassDoc[] |
exceptions()
Included exceptions in this package. |
GroovyClassDoc |
findClass(String arg0)
Find a class or interface within this package. |
String |
getRelativeRootPath()
|
GroovyClassDoc[] |
interfaces()
Included interfaces in this package. |
String |
nameWithDots()
|
GroovyClassDoc[] |
ordinaryClasses()
Included ordinary classes in this package. |
void |
putAll(Map<String,GroovyClassDoc> classes)
|
void |
setDescription(String description)
|
void |
setSummary(String summary)
|
String |
summary()
The one-sentence summary for the package derived from the beginning of the description. |
| Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc |
|---|
calculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setTokenType, tags, tokenType, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyDoc |
|---|
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText |
| Methods inherited from interface java.lang.Comparable |
|---|
compareTo |
| Constructor Detail |
|---|
public SimpleGroovyPackageDoc(String name)
| Method Detail |
|---|
public GroovyClassDoc[] allClasses()
GroovyPackageDoc
allClasses in interface GroovyPackageDocpublic void setDescription(String description)
public void setSummary(String summary)
public void putAll(Map<String,GroovyClassDoc> classes)
public String nameWithDots()
nameWithDots in interface GroovyPackageDocpublic GroovyClassDoc[] allClasses(boolean arg0)
GroovyPackageDoc
allClasses in interface GroovyPackageDocarg0 - Specifying true filters according to the specified access modifier option.
Specifying false includes all classes and interfaces regardless of access modifier option.
public GroovyClassDoc[] enums()
GroovyPackageDoc
enums in interface GroovyPackageDocpublic GroovyClassDoc[] errors()
GroovyPackageDoc
errors in interface GroovyPackageDocpublic GroovyClassDoc[] exceptions()
GroovyPackageDoc
exceptions in interface GroovyPackageDocpublic GroovyClassDoc findClass(String arg0)
GroovyPackageDoc
findClass in interface GroovyPackageDocarg0 - the name of the class to find
public GroovyClassDoc[] interfaces()
GroovyPackageDoc
interfaces in interface GroovyPackageDocpublic GroovyClassDoc[] ordinaryClasses()
GroovyPackageDoc
ordinaryClasses in interface GroovyPackageDocpublic String description()
GroovyPackageDoc
description in interface GroovyPackageDocpublic String summary()
GroovyPackageDoc
summary in interface GroovyPackageDocpublic String getRelativeRootPath()
getRelativeRootPath in interface GroovyPackageDoc
|
Copyright © 2003-2009 The Codehaus. All rights reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||