Tue, 22 Oct 2013 17:42:10 -0700
8027119: Cleanup javadoc comments for taglet API
Reviewed-by: mduigou
duke@1 | 1 | /* |
jjg@1521 | 2 | * Copyright (c) 2003, 2013, 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 | /** |
duke@1 | 30 | * Represents a type variable. |
duke@1 | 31 | * For example, the generic interface {@code List<E>} has a single |
duke@1 | 32 | * type variable {@code E}. |
duke@1 | 33 | * A type variable may have explicit bounds, as in |
duke@1 | 34 | * {@code C<R extends Remote>}. |
duke@1 | 35 | * |
duke@1 | 36 | * @author Scott Seligman |
duke@1 | 37 | * @since 1.5 |
duke@1 | 38 | */ |
duke@1 | 39 | public interface TypeVariable extends Type { |
duke@1 | 40 | |
duke@1 | 41 | /** |
duke@1 | 42 | * Return the bounds of this type variable. |
duke@1 | 43 | * These are the types given by the <i>extends</i> clause. |
duke@1 | 44 | * Return an empty array if there are no explicit bounds. |
duke@1 | 45 | * |
duke@1 | 46 | * @return the bounds of this type variable. |
duke@1 | 47 | */ |
duke@1 | 48 | Type[] bounds(); |
duke@1 | 49 | |
duke@1 | 50 | /** |
duke@1 | 51 | * Return the class, interface, method, or constructor within |
duke@1 | 52 | * which this type variable is declared. |
duke@1 | 53 | * |
duke@1 | 54 | * @return the class, interface, method, or constructor within |
duke@1 | 55 | * which this type variable is declared. |
duke@1 | 56 | */ |
duke@1 | 57 | ProgramElementDoc owner(); |
jjg@1521 | 58 | |
jjg@1521 | 59 | /** |
jjg@1521 | 60 | * Get the annotations of this program element. |
jjg@1521 | 61 | * Return an empty array if there are none. |
jjg@1521 | 62 | */ |
jjg@1521 | 63 | public AnnotationDesc[] annotations(); |
jjg@1521 | 64 | |
duke@1 | 65 | } |