Class sun.tools.javadoc.Root
java.lang.Object
|
+----sun.tools.javadoc.Doc
|
+----sun.tools.javadoc.Root
- public class Root
- extends Doc
- implements sun.tools.java.Constants
This class holds the information from one run of javadoc.
Particularly the packages, classes and options specified
by the user..
- Since:
- JDK1.2
Method Summary
|
ClassDoc[]
|
classes()
classes and interfaces to be documented.
|
ClassDoc
|
classNamed(java.lang.String qualifiedName)
Return a ClassDoc for the specified class/interface name
|
boolean
|
isIncluded()
return true if this Doc is include in the active set.
|
java.lang.String
|
name()
Return the name of this Doc item.
|
java.lang.String[][]
|
options()
Command line options.
|
PackageDoc
|
PackageDoc(java.lang.String name)
Return a PackageDoc for the specified class/interface name
|
static void
|
printError(java.lang.String msg)
Print error message, increment error count.
|
static void
|
printNotice(java.lang.String msg)
Print a message.
|
static void
|
printWarning(java.lang.String msg)
Print warning message, increment warning count.
|
ClassDoc[]
|
specifiedClasses()
classes and interfaces specified on the command line.
|
PackageDoc[]
|
specifiedPackages()
packages specified on the command line.
|
Methods inherited from class sun.tools.javadoc.Doc
|
commentText, compareTo, getRawCommentText, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags, toString |
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
options
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"
- Returns:
- an array of arrays of String.
specifiedPackages
public PackageDoc[] specifiedPackages()
- packages specified on the command line.
specifiedClasses
public ClassDoc[] specifiedClasses()
- classes and interfaces specified on the command line.
classes
public ClassDoc[] classes()
- classes and interfaces to be documented.
name
public java.lang.String name()
- Return the name of this Doc item.
- Returns:
- the string
"*Root*"
. - Overrides:
- name in class Doc
PackageDoc
public PackageDoc PackageDoc(java.lang.String name)
- Return a PackageDoc for the specified class/interface name
- Parameters:
name
- package name
- Returns:
- a PackageDoc holding the specified package, null if
this package is not referenced.
classNamed
public ClassDoc classNamed(java.lang.String qualifiedName)
- Return a ClassDoc for the specified class/interface name
- Parameters:
qualifiedName
- qualified class name
(i.e. includes package name).
- Returns:
- a ClassDoc holding the specified class, null if
this class is not referenced.
isIncluded
public boolean isIncluded()
- return true if this Doc is include in the active set.
Root isn't even a program entity so it is always false.
- Overrides:
- isIncluded in class Doc
printError
public static void printError(java.lang.String msg)
- Print error message, increment error count.
- Parameters:
msg
- message to print
printWarning
public static void printWarning(java.lang.String msg)
- Print warning message, increment warning count.
- Parameters:
msg
- message to print
printNotice
public static void printNotice(java.lang.String msg)
- Print a message.
- Parameters:
msg
- message to print