Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/javadoc/RootDoc.java@998b10c43157 (annotated)
src/share/classes/com/sun/javadoc/RootDoc.java
Tue, 24 Dec 2013 09:17:37 -0800
- author
- ksrini
- date
- Tue, 24 Dec 2013 09:17:37 -0800
- changeset 2227
- 998b10c43157
- parent 554
- 9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * Represents the root of the program structure information |
| duke@1 | 30 | * for one run of javadoc. From this root all other program |
| duke@1 | 31 | * structure information can be extracted. |
| duke@1 | 32 | * Also represents the command line information -- the |
| duke@1 | 33 | * packages, classes and options specified by the user. |
| duke@1 | 34 | * |
| duke@1 | 35 | * @since 1.2 |
| duke@1 | 36 | * @author Robert Field |
| duke@1 | 37 | */ |
| duke@1 | 38 | public interface RootDoc extends Doc, DocErrorReporter { |
| duke@1 | 39 | |
| duke@1 | 40 | /** |
| duke@1 | 41 | * Command line options. |
| duke@1 | 42 | * <p> |
| duke@1 | 43 | * For example, given: |
| duke@1 | 44 | * <pre> |
| duke@1 | 45 | * javadoc -foo this that -bar other ...</pre> |
| duke@1 | 46 | * |
| duke@1 | 47 | * this method will return: |
| duke@1 | 48 | * <pre> |
| duke@1 | 49 | * options()[0][0] = "-foo" |
| duke@1 | 50 | * options()[0][1] = "this" |
| duke@1 | 51 | * options()[0][2] = "that" |
| duke@1 | 52 | * options()[1][0] = "-bar" |
| duke@1 | 53 | * options()[1][1] = "other"</pre> |
| duke@1 | 54 | * |
| duke@1 | 55 | * @return an array of arrays of String. |
| duke@1 | 56 | */ |
| duke@1 | 57 | String[][] options(); |
| duke@1 | 58 | |
| duke@1 | 59 | /** |
| duke@1 | 60 | * Return the packages |
| duke@1 | 61 | * <a href="package-summary.html#included">specified</a> |
| duke@1 | 62 | * on the command line. |
| duke@1 | 63 | * If <code>-subpackages</code> and <code>-exclude</code> options |
| duke@1 | 64 | * are used, return all the non-excluded packages. |
| duke@1 | 65 | * |
| duke@1 | 66 | * @return packages specified on the command line. |
| duke@1 | 67 | */ |
| duke@1 | 68 | PackageDoc[] specifiedPackages(); |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Return the classes and interfaces |
| duke@1 | 72 | * <a href="package-summary.html#included">specified</a> |
| duke@1 | 73 | * as source file names on the command line. |
| duke@1 | 74 | * |
| duke@1 | 75 | * @return classes and interfaces specified on the command line. |
| duke@1 | 76 | */ |
| duke@1 | 77 | ClassDoc[] specifiedClasses(); |
| duke@1 | 78 | |
| duke@1 | 79 | /** |
| duke@1 | 80 | * Return the |
| duke@1 | 81 | * <a href="package-summary.html#included">included</a> |
| duke@1 | 82 | classes and interfaces in all packages. |
| duke@1 | 83 | * |
| duke@1 | 84 | * @return included classes and interfaces in all packages. |
| duke@1 | 85 | */ |
| duke@1 | 86 | ClassDoc[] classes(); |
| duke@1 | 87 | |
| duke@1 | 88 | /** |
| duke@1 | 89 | * Return a PackageDoc for the specified package name. |
| duke@1 | 90 | * |
| duke@1 | 91 | * @param name package name |
| duke@1 | 92 | * |
| duke@1 | 93 | * @return a PackageDoc holding the specified package, null if |
| duke@1 | 94 | * this package is not referenced. |
| duke@1 | 95 | */ |
| duke@1 | 96 | PackageDoc packageNamed(String name); |
| duke@1 | 97 | |
| duke@1 | 98 | /** |
| duke@1 | 99 | * Return a ClassDoc for the specified class or interface name. |
| duke@1 | 100 | * |
| duke@1 | 101 | * @param qualifiedName |
| duke@1 | 102 | * <a href="package-summary.html#qualified">qualified</a> |
| duke@1 | 103 | * class or package name |
| duke@1 | 104 | * |
| duke@1 | 105 | * @return a ClassDoc holding the specified class, null if |
| duke@1 | 106 | * this class is not referenced. |
| duke@1 | 107 | */ |
| duke@1 | 108 | ClassDoc classNamed(String qualifiedName); |
| duke@1 | 109 | } |
