Tue, 22 Oct 2013 17:42:10 -0700
8027119: Cleanup javadoc comments for taglet API
Reviewed-by: mduigou
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 a java package. Provides access to information |
duke@1 | 30 | * about the package, the package's comment and tags, and the |
duke@1 | 31 | * classes in the package. |
duke@1 | 32 | * <p> |
duke@1 | 33 | * Each method whose return type is an array will return an empty |
duke@1 | 34 | * array (never null) when there are no objects in the result. |
duke@1 | 35 | * |
duke@1 | 36 | * @since 1.2 |
duke@1 | 37 | * @author Kaiyang Liu (original) |
duke@1 | 38 | * @author Robert Field (rewrite) |
duke@1 | 39 | */ |
duke@1 | 40 | public interface PackageDoc extends Doc { |
duke@1 | 41 | |
duke@1 | 42 | /** |
duke@1 | 43 | * Get all classes and interfaces in the package, filtered to the specified |
duke@1 | 44 | * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">access |
duke@1 | 45 | * modifier option</a>. |
duke@1 | 46 | * |
duke@1 | 47 | * @return filtered classes and interfaces in this package |
duke@1 | 48 | * @param filter Specifying true filters according to the specified access |
duke@1 | 49 | * modifier option. |
duke@1 | 50 | * Specifying false includes all classes and interfaces |
duke@1 | 51 | * regardless of access modifier option. |
duke@1 | 52 | * @since 1.4 |
duke@1 | 53 | */ |
duke@1 | 54 | ClassDoc[] allClasses(boolean filter); |
duke@1 | 55 | |
duke@1 | 56 | /** |
duke@1 | 57 | * Get all |
duke@1 | 58 | * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a> |
duke@1 | 59 | * classes and interfaces in the package. Same as allClasses(true). |
duke@1 | 60 | * |
duke@1 | 61 | * @return all included classes and interfaces in this package. |
duke@1 | 62 | */ |
duke@1 | 63 | ClassDoc[] allClasses(); |
duke@1 | 64 | |
duke@1 | 65 | /** |
duke@1 | 66 | * Get included |
duke@1 | 67 | * <a href="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary</a> |
duke@1 | 68 | * classes (that is, exclude exceptions, errors, enums, interfaces, and |
duke@1 | 69 | * annotation types) |
duke@1 | 70 | * in this package. |
duke@1 | 71 | * |
duke@1 | 72 | * @return included ordinary classes in this package. |
duke@1 | 73 | */ |
duke@1 | 74 | ClassDoc[] ordinaryClasses(); |
duke@1 | 75 | |
duke@1 | 76 | /** |
duke@1 | 77 | * Get included Exception classes in this package. |
duke@1 | 78 | * |
duke@1 | 79 | * @return included Exceptions in this package. |
duke@1 | 80 | */ |
duke@1 | 81 | ClassDoc[] exceptions(); |
duke@1 | 82 | |
duke@1 | 83 | /** |
duke@1 | 84 | * Get included Error classes in this package. |
duke@1 | 85 | * |
duke@1 | 86 | * @return included Errors in this package. |
duke@1 | 87 | */ |
duke@1 | 88 | ClassDoc[] errors(); |
duke@1 | 89 | |
duke@1 | 90 | /** |
duke@1 | 91 | * Get included enum types in this package. |
duke@1 | 92 | * |
duke@1 | 93 | * @return included enum types in this package. |
duke@1 | 94 | * @since 1.5 |
duke@1 | 95 | */ |
duke@1 | 96 | ClassDoc[] enums(); |
duke@1 | 97 | |
duke@1 | 98 | /** |
duke@1 | 99 | * Get included interfaces in this package, omitting annotation types. |
duke@1 | 100 | * |
duke@1 | 101 | * @return included interfaces in this package. |
duke@1 | 102 | */ |
duke@1 | 103 | ClassDoc[] interfaces(); |
duke@1 | 104 | |
duke@1 | 105 | /** |
duke@1 | 106 | * Get included annotation types in this package. |
duke@1 | 107 | * |
duke@1 | 108 | * @return included annotation types in this package. |
duke@1 | 109 | * @since 1.5 |
duke@1 | 110 | */ |
duke@1 | 111 | AnnotationTypeDoc[] annotationTypes(); |
duke@1 | 112 | |
duke@1 | 113 | /** |
duke@1 | 114 | * Get the annotations of this package. |
duke@1 | 115 | * Return an empty array if there are none. |
duke@1 | 116 | * |
duke@1 | 117 | * @return the annotations of this package. |
duke@1 | 118 | * @since 1.5 |
duke@1 | 119 | */ |
duke@1 | 120 | AnnotationDesc[] annotations(); |
duke@1 | 121 | |
duke@1 | 122 | /** |
duke@1 | 123 | * Lookup a class or interface within this package. |
duke@1 | 124 | * |
duke@1 | 125 | * @return ClassDoc of found class or interface, |
duke@1 | 126 | * or null if not found. |
duke@1 | 127 | */ |
duke@1 | 128 | ClassDoc findClass(String className); |
duke@1 | 129 | } |