duke@1: /*
ohair@554: * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.javadoc;
duke@1:
duke@1: /**
duke@1: * Represents an @param documentation tag.
duke@1: * Stores the name and comment parts of the parameter tag.
duke@1: * An @param tag may represent either a method or constructor parameter,
duke@1: * or a type parameter.
duke@1: *
duke@1: * @author Robert Field
duke@1: *
duke@1: */
duke@1: public interface ParamTag extends Tag {
duke@1:
duke@1: /**
duke@1: * Return the name of the parameter or type parameter
duke@1: * associated with this ParamTag
.
duke@1: * The angle brackets delimiting a type parameter are not part of
duke@1: * its name.
duke@1: *
duke@1: * @return the parameter name.
duke@1: */
duke@1: String parameterName();
duke@1:
duke@1: /**
duke@1: * Return the parameter comment
duke@1: * associated with this ParamTag
.
duke@1: *
duke@1: * @return the parameter comment.
duke@1: */
duke@1: String parameterComment();
duke@1:
duke@1: /**
duke@1: * Return true if this ParamTag
corresponds to a type
duke@1: * parameter. Return false if it corresponds to an ordinary parameter
duke@1: * of a method or constructor.
duke@1: *
duke@1: * @return true if this ParamTag
corresponds to a type
duke@1: * parameter.
duke@1: * @since 1.5
duke@1: */
duke@1: boolean isTypeParameter();
duke@1: }