| java.lang.Object
 com.sun.tools.javadoc.DocImpl
com.sun.tools.javadoc.RootDocImpl
| RootDocImpl | | public class RootDocImpl extends DocImpl implements RootDoc(Code) | | This class holds the information from one run of javadoc.
Particularly the packages, classes and options specified
by the user..
since:
1.2
author:
Robert Field
author:
Atul M Dambalkar
author:
Neal Gafter (rewrite) |
| Method Summary | |
| public ClassDoc | classNamed(String qualifiedName)
Return a ClassDoc for the specified class/interface name
Parameters:
qualifiedName - qualified class name(i.e. | | public ClassDoc[] | classes()
Return all classes and interfaces (including those inside
packages) to be documented. | | protected String | documentation()
Do lazy initialization of "documentation" string. | | public boolean | isIncluded()
Return true if this Doc is include in the active set. | | public String | name()
Return the name of this Doc item. | | public String[][] | options()
Command line options. | | public PackageDoc | packageNamed(String name)
| | public SourcePosition | position()
Return the source position of the entity, or null if
no position is available. | | public void | printError(String msg)
Print error message, increment error count. | | public void | printError(SourcePosition pos, String msg)
Print error message, increment error count. | | public void | printNotice(String msg)
Print a message. | | public void | printNotice(SourcePosition pos, String msg)
Print a message. | | public void | printWarning(String msg)
Print warning message, increment warning count. | | public void | printWarning(SourcePosition pos, String msg)
Print warning message, increment warning count. | | public String | qualifiedName()
Return the name of this Doc item. | | public ClassDoc[] | specifiedClasses()
Classes and interfaces specified on the command line. | | public PackageDoc[] | specifiedPackages()
Packages specified on the command line. |
| RootDocImpl | | public RootDocImpl(DocEnv env, List<JCClassDecl> classes, List<String> packages, List<String[]> options)(Code) | | Constructor used when reading source files.
Parameters:
env - the documentation environment, state for this javadoc run
Parameters:
classes - list of classes specified on the commandline
Parameters:
packages - list of package names specified on the commandline
Parameters:
options - list of options |
| RootDocImpl | | public RootDocImpl(DocEnv env, List<String> classes, List<String[]> options)(Code) | | Constructor used when reading class files.
Parameters:
env - the documentation environment, state for this javadoc run
Parameters:
classes - list of class names specified on the commandline
Parameters:
options - list of options |
| classNamed | | public ClassDoc classNamed(String qualifiedName)(Code) | | Return a ClassDoc for the specified class/interface name
Parameters:
qualifiedName - qualified class name(i.e. includes package name). a ClassDocImpl holding the specified class, null ifthis class is not referenced. |
| classes | | public ClassDoc[] classes()(Code) | | Return all classes and interfaces (including those inside
packages) to be documented.
|
| documentation | | protected String documentation()(Code) | | Do lazy initialization of "documentation" string.
|
| isIncluded | | public boolean isIncluded()(Code) | | Return true if this Doc is include in the active set.
RootDocImpl isn't even a program entity so it is always false.
|
| name | | public String name()(Code) | | Return the name of this Doc item.
the string "*RootDocImpl*". |
| options | | public String[][] options()(Code) | | 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"
an array of arrays of String. |
| packageNamed | | public PackageDoc packageNamed(String name)(Code) | | Return a PackageDoc for the specified package name
Parameters:
name - package name a PackageDoc holding the specified package, null ifthis package is not referenced. |
| position | | public SourcePosition position()(Code) | | Return the source position of the entity, or null if
no position is available.
|
| printError | | public void printError(String msg)(Code) | | Print error message, increment error count.
Parameters:
msg - message to print |
| printError | | public void printError(SourcePosition pos, String msg)(Code) | | Print error message, increment error count.
Parameters:
msg - message to print |
| printNotice | | public void printNotice(String msg)(Code) | | Print a message.
Parameters:
msg - message to print |
| printNotice | | public void printNotice(SourcePosition pos, String msg)(Code) | | Print a message.
Parameters:
msg - message to print |
| printWarning | | public void printWarning(String msg)(Code) | | Print warning message, increment warning count.
Parameters:
msg - message to print |
| printWarning | | public void printWarning(SourcePosition pos, String msg)(Code) | | Print warning message, increment warning count.
Parameters:
msg - message to print |
| qualifiedName | | public String qualifiedName()(Code) | | Return the name of this Doc item.
the string "*RootDocImpl*". |
| specifiedClasses | | public ClassDoc[] specifiedClasses()(Code) | | Classes and interfaces specified on the command line.
|
| specifiedPackages | | public PackageDoc[] specifiedPackages()(Code) | | Packages specified on the command line.
|
|
|