net.cscott.sinjdoc.parser
public class PRootDoc extends PDoc implements RootDoc
PRootDoc class holds the information from one run of
SinjDoc; in particular the packages, classes, and options specified by
the user.
Version: $Id: PRootDoc.java,v 1.25 2003/08/01 00:01:26 cananian Exp $
| Method Summary | |
|---|---|
| Collection<ClassDoc> | classes() |
| ClassDoc | classNamed(String canonicalName) |
| TypeContext | getCommentContext() |
| PSourcePosition | getRawCommentPosition() |
| String | getRawCommentText() |
| boolean | isIncluded() |
| String | name() |
| List<List<String>> | options() |
| PPackageDoc | packageNamed(String name) |
| void | printError(String msg) |
| void | printError(SourcePosition pos, String msg) |
| void | printNotice(String msg) |
| void | printNotice(SourcePosition pos, String msg) |
| void | printWarning(String msg) |
| void | printWarning(SourcePosition pos, String msg) |
| void | setOptions(List<List<String>> options) |
| boolean | shouldStripStars() |
| List<ClassDoc> | specifiedClasses() |
| List<PackageDoc> | specifiedPackages() |
Returns: false