net.cscott.sinjdoc
public interface RootDoc extends Doc, DocErrorReporter
RootDoc class holds the information from one run of
SinjDoc; in particular the packages, classes, and options specified by
the user.
Version: $Id: RootDoc.java,v 1.7 2003/05/08 03:54:25 cananian Exp $
See Also: com.sun.javadoc.RootDoc
| Method Summary | |
|---|---|
| Collection<ClassDoc> | classes()
Return the classes and interfaces to be documented. |
| ClassDoc | classNamed(String canonicalName)
Return a ClassDoc for the specified class or interface
name. |
| List<List<String>> | options() Command-line options.
|
| PackageDoc | packageNamed(String name)
Return a PackageDoc for the specified fully-qualified
package name. |
| List<ClassDoc> | specifiedClasses()
Return the classes and interfaces specified on the command line.
|
| List<PackageDoc> | specifiedPackages()
Return the packages specified on the command-line, either directly
or via a -subpackages option. |
specifiedClasses() as well
as classes within the packages returned by
specifiedPackages().ClassDoc for the specified class or interface
name.Parameters: canonicalName canonical class name.
Returns: a ClassDoc representing the specified class,
or null if this class is not referenced.
PackageDoc for the specified fully-qualified
package name.Parameters: name a fully-qualified package name.
Returns: a PackageDoc holding the specified package,
or null if this package is not referenced.
-subpackages option.