FileDocCategorySizeDatePackage
RootDoc.javaAPI DocJava SE 6 API2576Tue Jun 10 00:22:00 BST 2008com.sun.javadoc

RootDoc

public interface RootDoc implements DocErrorReporter, Doc
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.
since
1.2
author
Robert Field

Fields Summary
Constructors Summary
Methods Summary
public ClassDocclassNamed(java.lang.String qualifiedName)
Return a ClassDoc for the specified class or interface name.

param
qualifiedName qualified class or package name
return
a ClassDoc holding the specified class, null if this class is not referenced.

public ClassDoc[]classes()
Return the included classes and interfaces in all packages.

return
included classes and interfaces in all packages.

public java.lang.String[][]options()
Command line 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"

return
an array of arrays of String.

public PackageDocpackageNamed(java.lang.String name)
Return a PackageDoc for the specified package name.

param
name package name
return
a PackageDoc holding the specified package, null if this package is not referenced.

public ClassDoc[]specifiedClasses()
Return the classes and interfaces specified as source file names on the command line.

return
classes and interfaces specified on the command line.

public PackageDoc[]specifiedPackages()
Return the packages specified on the command line. If -subpackages and -exclude options are used, return all the non-excluded packages.

return
packages specified on the command line.