gw.gosudoc.com.sun.javadoc.RootDoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gosu-doc Show documentation
Generates Javadoc-compatible documentation for Gosu projects
The newest version!
/*
 * This file is a shadowed version of the older javadoc codebase on which gosudoc is based; borrowed from jdk 9.
 */

package gw.gosudoc.com.sun.javadoc;

/**
 * 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
 * @author Robert Field
 *
 * @deprecated
 *   The declarations in this package have been superseded by those
 *   in the package {@code jdk.javadoc.doclet}.
 *   For more information, see the Migration Guide in the documentation for that package.
 */
@Deprecated
public interface RootDoc extends Doc, DocErrorReporter
{

    /**
     * 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"
     *
     * @return an array of arrays of String.
     */
    String[][] options();

    /**
     * Return the packages
     * specified
     * on the command line.
     * If {@code -subpackages} and {@code -exclude} options
     * are used, return all the non-excluded packages.
     *
     * @return packages specified on the command line.
     */
    gw.gosudoc.com.sun.javadoc.PackageDoc[] specifiedPackages();

    /**
     * Return the classes and interfaces
     * specified
     * as source file names on the command line.
     *
     * @return classes and interfaces specified on the command line.
     */
    gw.gosudoc.com.sun.javadoc.ClassDoc[] specifiedClasses();

    /**
     * Return the
     * included
      classes and interfaces in all packages.
     *
     * @return included classes and interfaces in all packages.
     */
    gw.gosudoc.com.sun.javadoc.ClassDoc[] classes();

    /**
     * Return a PackageDoc for the specified package name.
     *
     * @param name package name
     *
     * @return a PackageDoc holding the specified package, null if
     * this package is not referenced.
     */
    PackageDoc packageNamed( String name);

    /**
     * Return a ClassDoc for the specified class or interface name.
     *
     * @param qualifiedName
     * qualified
     * class or package name
     *
     * @return a ClassDoc holding the specified class, null if
     * this class is not referenced.
     */
    ClassDoc classNamed( String qualifiedName);
}