Class JavadocTool

java.lang.Object
com.sun.tools.javac.main.JavaCompiler
gw.gosudoc.com.sun.tools.javadoc.main.JavadocTool

@Deprecated public class JavadocTool extends com.sun.tools.javac.main.JavaCompiler
Deprecated.
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.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    (package private) class 
    Deprecated.
    A table to manage included and excluded packages.

    Nested classes/interfaces inherited from class com.sun.tools.javac.main.JavaCompiler

    com.sun.tools.javac.main.JavaCompiler.CompilePolicy, com.sun.tools.javac.main.JavaCompiler.ImplicitSourcePolicy
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) DocEnv
    Deprecated.
     
    (package private) final com.sun.tools.javac.comp.Enter
    Deprecated.
     
    (package private) final com.sun.tools.javac.code.ClassFinder
    Deprecated.
     
    (package private) final Messager
    Deprecated.
     
    (package private) static final boolean
    Deprecated.
    Are surrogates supported?
    (package private) final Set<JavaFileObject>
    Deprecated.
     

    Fields inherited from class com.sun.tools.javac.main.JavaCompiler

    analyzer, annotate, annotationProcessingOccurred, attr, chk, closeables, compilePolicy, compilerKey, compileStates, completionFailureName, context, dcfh, devVerbose, diags, elapsed_msec, enter, explicitAnnotationProcessingRequested, fileManager, finder, flow, gen, genEndPos, implicitSourceFilesRead, implicitSourcePolicy, inputFiles, jniWriter, keepComments, lineDebugInfo, log, lower, make, moduleFinder, modules, names, options, parserFactory, preview, processPcks, reader, shouldStopPolicyIfError, shouldStopPolicyIfNoError, source, sourceCompleter, sourceOutput, syms, taskListener, todo, transTypes, types, verbose, verboseCompilePolicy, werror, writer
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    JavadocTool(com.sun.tools.javac.util.Context context)
    Deprecated.
    Construct a new JavaCompiler processor, using appropriately extended phases of the underlying compiler.
  • Method Summary

    Modifier and Type
    Method
    Description
    getRootDocImpl(String doclocale, String encoding, ModifierFilter filter, com.sun.tools.javac.util.List<String> args, com.sun.tools.javac.util.List<String[]> options, Iterable<? extends JavaFileObject> fileObjects, boolean breakiterator, com.sun.tools.javac.util.List<String> subPackages, com.sun.tools.javac.util.List<String> excludedPackages, boolean docClasses, boolean legacyDoclet, boolean quiet)
    Deprecated.
     
    static boolean
    Deprecated.
    Return true if given file name is a valid class name (including "package-info").
    (package private) boolean
    Deprecated.
    Is the given string a valid package name?
    protected boolean
    Deprecated.
    For javadoc, the parser needs to keep comments.
    (package private) com.sun.tools.javac.util.List<com.sun.tools.javac.tree.JCTree.JCClassDecl>
    listClasses(com.sun.tools.javac.util.List<com.sun.tools.javac.tree.JCTree.JCCompilationUnit> trees)
    Deprecated.
    From a list of top level trees, return the list of contained class definitions
    make0(com.sun.tools.javac.util.Context context)
    Deprecated.
    Construct a new javadoc tool.
    private void
    parse(Iterable<? extends JavaFileObject> files, com.sun.tools.javac.util.ListBuffer<com.sun.tools.javac.tree.JCTree.JCCompilationUnit> trees, boolean trace)
    Deprecated.
     
    private static boolean
    Deprecated.
     

    Methods inherited from class com.sun.tools.javac.main.JavaCompiler

    attribute, attribute, checkReusable, close, compile, compile, continueAfterProcessAnnotations, desugar, desugar, enterDone, enterTrees, errorCount, flow, flow, flow, fullVersion, generate, generate, initModules, initProcessAnnotations, instance, isEnterDone, newRound, parse, parse, parse, parseFiles, parseFiles, printCount, printNote, processAnnotations, processAnnotations, readSource, readSourceFile, reportDeferredDiagnostics, resolveBinaryNameOrIdent, resolveBinaryNameOrIdent, resolveIdent, setDeferredDiagnosticHandler, shouldStop, stopIfError, stopIfError, version, warningCount

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • docenv

      DocEnv docenv
      Deprecated.
    • messager

      final Messager messager
      Deprecated.
    • javadocFinder

      final com.sun.tools.javac.code.ClassFinder javadocFinder
      Deprecated.
    • javadocEnter

      final com.sun.tools.javac.comp.Enter javadocEnter
      Deprecated.
    • uniquefiles

      final Set<JavaFileObject> uniquefiles
      Deprecated.
    • surrogatesSupported

      static final boolean surrogatesSupported
      Deprecated.
      Are surrogates supported?
  • Constructor Details

    • JavadocTool

      protected JavadocTool(com.sun.tools.javac.util.Context context)
      Deprecated.
      Construct a new JavaCompiler processor, using appropriately extended phases of the underlying compiler.
  • Method Details

    • keepComments

      protected boolean keepComments()
      Deprecated.
      For javadoc, the parser needs to keep comments. Overrides method from JavaCompiler.
      Overrides:
      keepComments in class com.sun.tools.javac.main.JavaCompiler
    • make0

      public static JavadocTool make0(com.sun.tools.javac.util.Context context)
      Deprecated.
      Construct a new javadoc tool.
    • getRootDocImpl

      public RootDocImpl getRootDocImpl(String doclocale, String encoding, ModifierFilter filter, com.sun.tools.javac.util.List<String> args, com.sun.tools.javac.util.List<String[]> options, Iterable<? extends JavaFileObject> fileObjects, boolean breakiterator, com.sun.tools.javac.util.List<String> subPackages, com.sun.tools.javac.util.List<String> excludedPackages, boolean docClasses, boolean legacyDoclet, boolean quiet) throws IOException
      Deprecated.
      Throws:
      IOException
    • isValidPackageName

      boolean isValidPackageName(String s)
      Deprecated.
      Is the given string a valid package name?
    • parse

      private void parse(Iterable<? extends JavaFileObject> files, com.sun.tools.javac.util.ListBuffer<com.sun.tools.javac.tree.JCTree.JCCompilationUnit> trees, boolean trace)
      Deprecated.
    • surrogatesSupported

      private static boolean surrogatesSupported()
      Deprecated.
    • isValidClassName

      public static boolean isValidClassName(String s)
      Deprecated.
      Return true if given file name is a valid class name (including "package-info").
      Parameters:
      s - the name of the class to check.
      Returns:
      true if given class name is a valid class name and false otherwise.
    • listClasses

      com.sun.tools.javac.util.List<com.sun.tools.javac.tree.JCTree.JCClassDecl> listClasses(com.sun.tools.javac.util.List<com.sun.tools.javac.tree.JCTree.JCCompilationUnit> trees)
      Deprecated.
      From a list of top level trees, return the list of contained class definitions