Class 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.

    Author:
    Neal Gafter
    • Nested Class Summary

      • 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 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

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      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)
      Deprecated.
       
      static boolean isValidClassName​(String s)
      Deprecated.
      Return true if given file name is a valid class name (including "package-info").
      protected boolean keepComments()
      Deprecated.
      For javadoc, the parser needs to keep comments.
      static JavadocTool make0​(com.sun.tools.javac.util.Context context)
      Deprecated.
      Construct a new javadoc tool.
      • 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, printCount, printNote, processAnnotations, processAnnotations, readSource, readSourceFile, reportDeferredDiagnostics, resolveBinaryNameOrIdent, resolveBinaryNameOrIdent, resolveIdent, setDeferredDiagnosticHandler, shouldStop, stopIfError, stopIfError, version, warningCount
    • Constructor Detail

      • 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 Detail

      • 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.
      • 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.