| java.lang.Object
 com.sun.tools.javac.main.JavaCompiler
com.sun.tools.javadoc.JavadocTool
| JavadocTool | | public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler (Code) | | This class could be the main entry point for Javadoc when Javadoc is used as a
component in a larger software system. It provides operations to
construct a new javadoc processor, and to run it on a set of source
files.
author:
Neal Gafter |
| Constructor Summary | |
| protected | JavadocTool(Context context)
Construct a new JavaCompiler processor, using appropriately
extended phases of the underlying compiler. |
| Method Summary | |
| public RootDocImpl | getRootDocImpl(String doclocale, String encoding, ModifierFilter filter, List<String> javaNames, List<String[]> options, boolean breakiterator, List<String> subPackages, List<String> excludedPackages, boolean docClasses, boolean legacyDoclet, boolean quiet)
| | public static boolean | isValidClassName(String s)
Return true if given file name is a valid class name
(including "package-info").
Parameters:
clazzname - the name of the class to check. | | boolean | isValidPackageName(String s)
| | protected boolean | keepComments()
For javadoc, the parser needs to keep comments. | | List<JCClassDecl> | listClasses(List<JCCompilationUnit> trees)
| | public static JavadocTool | make0(Context context)
Construct a new javadoc tool. |
| surrogatesSupported | | final static boolean surrogatesSupported(Code) | | Are surrogates supported?
|
| JavadocTool | | protected JavadocTool(Context context)(Code) | | Construct a new JavaCompiler processor, using appropriately
extended phases of the underlying compiler.
|
| getRootDocImpl | | public RootDocImpl getRootDocImpl(String doclocale, String encoding, ModifierFilter filter, List<String> javaNames, List<String[]> options, boolean breakiterator, List<String> subPackages, List<String> excludedPackages, boolean docClasses, boolean legacyDoclet, boolean quiet) throws IOException(Code) | | |
| isValidClassName | | public static boolean isValidClassName(String s)(Code) | | Return true if given file name is a valid class name
(including "package-info").
Parameters:
clazzname - the name of the class to check. true if given class name is a valid class nameand false otherwise. |
| isValidPackageName | | boolean isValidPackageName(String s)(Code) | | Is the given string a valid package name?
|
| keepComments | | protected boolean keepComments()(Code) | | For javadoc, the parser needs to keep comments. Overrides method from JavaCompiler.
|
| listClasses | | List<JCClassDecl> listClasses(List<JCCompilationUnit> trees)(Code) | | From a list of top level trees, return the list of contained class definitions
|
| Methods inherited from com.sun.tools.javac.main.JavaCompiler | public List<Env<AttrContext>> attribute(ListBuffer<Env<AttrContext>> envs)(Code)(Java Doc)
public Env<AttrContext> attribute(Env<AttrContext> env)(Code)(Java Doc)
public void close()(Code)(Java Doc)
public void compile(List<JavaFileObject> sourceFileObject) throws Throwable(Code)(Java Doc)
public void compile(List<JavaFileObject> sourceFileObjects, List<String> classnames, Iterable<? extends Processor> processors) throws IOException(Code)(Java Doc)
public void complete(ClassSymbol c) throws CompletionFailure(Code)(Java Doc)
public List<Pair<Env<AttrContext>, JCClassDecl>> desugar(List<Env<AttrContext>> envs)(Code)(Java Doc)
protected void desugar(Env<AttrContext> env, ListBuffer<Pair<Env<AttrContext>, JCClassDecl>> results)(Code)(Java Doc)
public boolean desugarLater(Env<AttrContext> env)(Code)(Java Doc)
public static void enableLogging()(Code)(Java Doc)
public List<JCCompilationUnit> enterTrees(List<JCCompilationUnit> roots)(Code)(Java Doc)
public int errorCount()(Code)(Java Doc)
public List<Env<AttrContext>> flow(List<Env<AttrContext>> envs)(Code)(Java Doc)
public List<Env<AttrContext>> flow(Env<AttrContext> env)(Code)(Java Doc)
protected void flow(Env<AttrContext> env, ListBuffer<Env<AttrContext>> results)(Code)(Java Doc)
public static String fullVersion()(Code)(Java Doc)
public void generate(List<Pair<Env<AttrContext>, JCClassDecl>> list)(Code)(Java Doc)
public void generate(List<Pair<Env<AttrContext>, JCClassDecl>> list, ListBuffer<JavaFileObject> results)(Code)(Java Doc)
protected Scanner.Factory getScannerFactory()(Code)(Java Doc)
public void initProcessAnnotations(Iterable<? extends Processor> processors)(Code)(Java Doc)
public void initRound(JavaCompiler prev)(Code)(Java Doc)
public static JavaCompiler instance(Context context)(Code)(Java Doc)
protected boolean keepComments()(Code)(Java Doc)
protected JCCompilationUnit parse(JavaFileObject filename, CharSequence content)(Code)(Java Doc)
public JCTree.JCCompilationUnit parse(String filename) throws IOException(Code)(Java Doc)
public JCTree.JCCompilationUnit parse(JavaFileObject filename)(Code)(Java Doc)
public boolean parseErrors()(Code)(Java Doc)
public List<JCCompilationUnit> parseFiles(List<JavaFileObject> fileObjects) throws IOException(Code)(Java Doc)
protected void printCount(String kind, int count)(Code)(Java Doc)
protected void printVerbose(String key, Object arg)(Code)(Java Doc)
public JavaCompiler processAnnotations(List<JCCompilationUnit> roots) throws IOException(Code)(Java Doc)
public JavaCompiler processAnnotations(List<JCCompilationUnit> roots, List<String> classnames) throws IOException(Code)(Java Doc)
public CharSequence readSource(JavaFileObject filename)(Code)(Java Doc)
public void reportDeferredDiagnostics()(Code)(Java Doc)
public Symbol resolveIdent(String name)(Code)(Java Doc)
final protected List<T> stopIfError(ListBuffer<T> listBuffer)(Code)(Java Doc)
final protected List<T> stopIfError(List<T> list)(Code)(Java Doc)
public static String version()(Code)(Java Doc)
public int warningCount()(Code)(Java Doc)
|
|
|