Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/javadoc/ParamTag.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/javadoc/ParamTag.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
Initial load
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 1998-2003 Sun Microsystems, Inc. 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 |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun 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 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * Represents an @param documentation tag. |
| duke@1 | 30 | * Stores the name and comment parts of the parameter tag. |
| duke@1 | 31 | * An @param tag may represent either a method or constructor parameter, |
| duke@1 | 32 | * or a type parameter. |
| duke@1 | 33 | * |
| duke@1 | 34 | * @author Robert Field |
| duke@1 | 35 | * |
| duke@1 | 36 | */ |
| duke@1 | 37 | public interface ParamTag extends Tag { |
| duke@1 | 38 | |
| duke@1 | 39 | /** |
| duke@1 | 40 | * Return the name of the parameter or type parameter |
| duke@1 | 41 | * associated with this <code>ParamTag</code>. |
| duke@1 | 42 | * The angle brackets delimiting a type parameter are not part of |
| duke@1 | 43 | * its name. |
| duke@1 | 44 | * |
| duke@1 | 45 | * @return the parameter name. |
| duke@1 | 46 | */ |
| duke@1 | 47 | String parameterName(); |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * Return the parameter comment |
| duke@1 | 51 | * associated with this <code>ParamTag</code>. |
| duke@1 | 52 | * |
| duke@1 | 53 | * @return the parameter comment. |
| duke@1 | 54 | */ |
| duke@1 | 55 | String parameterComment(); |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * Return true if this <code>ParamTag</code> corresponds to a type |
| duke@1 | 59 | * parameter. Return false if it corresponds to an ordinary parameter |
| duke@1 | 60 | * of a method or constructor. |
| duke@1 | 61 | * |
| duke@1 | 62 | * @return true if this <code>ParamTag</code> corresponds to a type |
| duke@1 | 63 | * parameter. |
| duke@1 | 64 | * @since 1.5 |
| duke@1 | 65 | */ |
| duke@1 | 66 | boolean isTypeParameter(); |
| duke@1 | 67 | } |
