Module jdk.javadoc
Package com.sun.javadoc

Interface RootDoc

  • All Superinterfaces:
    Comparable<Object>, Doc, DocErrorReporter
    @Deprecated(since="9",
            forRemoval=true)
public interface RootDoc
extends Doc, DocErrorReporter
    Deprecated, for removal: This API element is subject to removal in a future version.
    The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
    Represents the root of the program structure information for one run of javadoc. From this root all other program structure information can be extracted. Also represents the command line information -- the packages, classes and options specified by the user.
    Since:
    1.2

    • Method Detail

      • options

        String[][] options()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Command line options.

        For example, given: 

             javadoc -foo this that -bar other ...
        this method will return: 
              options()[0][0] = "-foo"
      options()[0][1] = "this"
      options()[0][2] = "that"
      options()[1][0] = "-bar"
      options()[1][1] = "other"

        Returns:
        an array of arrays of String.

      • specifiedPackages

        PackageDoc[] specifiedPackages()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Return the packages specified on the command line. If -subpackages and -exclude options are used, return all the non-excluded packages.
        Returns:
        packages specified on the command line.

      • specifiedClasses

        ClassDoc[] specifiedClasses()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Return the classes and interfaces specified as source file names on the command line.
        Returns:
        classes and interfaces specified on the command line.

      • classes

        ClassDoc[] classes()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Return the included classes and interfaces in all packages.
        Returns:
        included classes and interfaces in all packages.

      • packageNamed

        PackageDoc packageNamed​(String name)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Return a PackageDoc for the specified package name.
        Parameters:
        name - package name
        Returns:
        a PackageDoc holding the specified package, null if this package is not referenced.

      • classNamed

        ClassDoc classNamed​(String qualifiedName)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Return a ClassDoc for the specified class or interface name.
        Parameters:
        qualifiedName - qualified class or package name
        Returns:
        a ClassDoc holding the specified class, null if this class is not referenced.