0N/A/*
553N/A * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.javadoc;
0N/A
0N/A/**
0N/A * Represents the root of the program structure information
0N/A * for one run of javadoc. From this root all other program
0N/A * structure information can be extracted.
0N/A * Also represents the command line information -- the
0N/A * packages, classes and options specified by the user.
0N/A *
0N/A * @since 1.2
0N/A * @author Robert Field
0N/A */
0N/Apublic interface RootDoc extends Doc, DocErrorReporter {
0N/A
0N/A /**
0N/A * Command line options.
0N/A * <p>
0N/A * For example, given:
0N/A * <pre>
0N/A * javadoc -foo this that -bar other ...</pre>
0N/A *
0N/A * this method will return:
0N/A * <pre>
0N/A * options()[0][0] = "-foo"
0N/A * options()[0][1] = "this"
0N/A * options()[0][2] = "that"
0N/A * options()[1][0] = "-bar"
0N/A * options()[1][1] = "other"</pre>
0N/A *
0N/A * @return an array of arrays of String.
0N/A */
0N/A String[][] options();
0N/A
0N/A /**
0N/A * Return the packages
0N/A * <a href="package-summary.html#included">specified</a>
0N/A * on the command line.
0N/A * If <code>-subpackages</code> and <code>-exclude</code> options
0N/A * are used, return all the non-excluded packages.
0N/A *
0N/A * @return packages specified on the command line.
0N/A */
0N/A PackageDoc[] specifiedPackages();
0N/A
0N/A /**
0N/A * Return the classes and interfaces
0N/A * <a href="package-summary.html#included">specified</a>
0N/A * as source file names on the command line.
0N/A *
0N/A * @return classes and interfaces specified on the command line.
0N/A */
0N/A ClassDoc[] specifiedClasses();
0N/A
0N/A /**
0N/A * Return the
0N/A * <a href="package-summary.html#included">included</a>
0N/A classes and interfaces in all packages.
0N/A *
0N/A * @return included classes and interfaces in all packages.
0N/A */
0N/A ClassDoc[] classes();
0N/A
0N/A /**
0N/A * Return a PackageDoc for the specified package name.
0N/A *
0N/A * @param name package name
0N/A *
0N/A * @return a PackageDoc holding the specified package, null if
0N/A * this package is not referenced.
0N/A */
0N/A PackageDoc packageNamed(String name);
0N/A
0N/A /**
0N/A * Return a ClassDoc for the specified class or interface name.
0N/A *
0N/A * @param qualifiedName
0N/A * <a href="package-summary.html#qualified">qualified</a>
0N/A * class or package name
0N/A *
0N/A * @return a ClassDoc holding the specified class, null if
0N/A * this class is not referenced.
0N/A */
0N/A ClassDoc classNamed(String qualifiedName);
0N/A}