Spec-Zone .ru
спецификации, руководства, описания, API
|
|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the root of the program structure information for one run of javadoc. From this root all other program structure information can be extracted. Also represents the command line information -- the packages, classes and options specified by the user.
Method Summary | |
ClassDoc[] |
classes()
Return the included classes and interfaces in all packages. |
ClassDoc |
classNamed(String qualifiedName)
Return a ClassDoc for the specified class or interface name. |
String[][] |
options()
Command line options. |
PackageDoc |
packageNamed(String name)
Return a PackageDoc for the specified package name. |
ClassDoc[] |
specifiedClasses()
Return the classes and interfaces specified as source file names on the command line. |
PackageDoc[] |
specifiedPackages()
Return the packages specified on the command line. |
Methods inherited from interface com.sun.javadoc.Doc |
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags |
Methods inherited from interface com.sun.javadoc.DocErrorReporter |
printError, printError, printNotice, printNotice, printWarning, printWarning |
Method Detail |
public String[][] options()
For example, given:
javadoc -foo this that -bar other ...this method will return:
options()[0][0] = "-foo" options()[0][1] = "this" options()[0][2] = "that" options()[1][0] = "-bar" options()[1][1] = "other"
public PackageDoc[] specifiedPackages()
-subpackages
and -exclude
options
are used, return all the non-excluded packages.
public ClassDoc[] specifiedClasses()
public ClassDoc[] classes()
public PackageDoc packageNamed(String name)
name
- package name
public ClassDoc classNamed(String qualifiedName)
qualifiedName
- qualified
class or package name
|
Doclet API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |