1 /*

     2  * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package com.sun.javadoc;

    27 

    28 /**

    29  * Represents the root of the program structure information

    30  * for one run of javadoc.  From this root all other program

    31  * structure information can be extracted.

    32  * Also represents the command line information -- the

    33  * packages, classes and options specified by the user.

    34  *

    35  * @since 1.2

    36  * @author Robert Field

    37  *

    38  * @deprecated

    39  *   The declarations in this package have been superseded by those

    40  *   in the package {@code jdk.javadoc.doclet}.

    41  *   For more information, see the <i>Migration Guide</i> in the documentation for that package.

    42  */

    43 @Deprecated(since="9", forRemoval=true)

    44 @SuppressWarnings("removal")

    45 public interface RootDoc extends Doc, DocErrorReporter {

    46 

    47     /**

    48      * Command line options.

    49      * <p>

    50      * For example, given:

    51      * <pre>

    52      *     javadoc -foo this that -bar other ...</pre>

    53      *

    54      * this method will return:

    55      * <pre>

    56      *      options()[0][0] = "-foo"

    57      *      options()[0][1] = "this"

    58      *      options()[0][2] = "that"

    59      *      options()[1][0] = "-bar"

    60      *      options()[1][1] = "other"</pre>

    61      *

    62      * @return an array of arrays of String.

    63      */

    64     String[][] options();

    65 

    66     /**

    67      * Return the packages

    68      * <a href="package-summary.html#included">specified</a>

    69      * on the command line.

    70      * If {@code -subpackages} and {@code -exclude} options

    71      * are used, return all the non-excluded packages.

    72      *

    73      * @return packages specified on the command line.

    74      */

    75     PackageDoc[] specifiedPackages();

    76 

    77     /**

    78      * Return the classes and interfaces

    79      * <a href="package-summary.html#included">specified</a>

    80      * as source file names on the command line.

    81      *

    82      * @return classes and interfaces specified on the command line.

    83      */

    84     ClassDoc[] specifiedClasses();

    85 

    86     /**

    87      * Return the

    88      * <a href="package-summary.html#included">included</a>

    89       classes and interfaces in all packages.

    90      *

    91      * @return included classes and interfaces in all packages.

    92      */

    93     ClassDoc[] classes();

    94 

    95     /**

    96      * Return a PackageDoc for the specified package name.

    97      *

    98      * @param name package name

    99      *

   100      * @return a PackageDoc holding the specified package, null if

   101      * this package is not referenced.

   102      */

   103     PackageDoc packageNamed(String name);

   104 

   105     /**

   106      * Return a ClassDoc for the specified class or interface name.

   107      *

   108      * @param qualifiedName

   109      * <a href="package-summary.html#qualified">qualified</a>

   110      * class or package name

   111      *

   112      * @return a ClassDoc holding the specified class, null if

   113      * this class is not referenced.

   114      */

   115     ClassDoc classNamed(String qualifiedName);

   116 }