ParamTag


1   /*
2    * @(#)ParamTag.java    1.9 03/12/19
3    *
4    * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5    * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6    */
7   
8   package com.sun.javadoc;
9   
10  /**
11   * Represents an @param documentation tag.
12   * Stores the name and comment parts of the parameter tag.
13   * An @param tag may represent either a method or constructor parameter,
14   * or a type parameter.
15   *
16   * @author Robert Field
17   *
18   */
19  public interface ParamTag extends Tag {
20  
21      /**
22       * Return the name of the parameter or type parameter
23       * associated with this <code>ParamTag</code>.
24       * The angle brackets delimiting a type parameter are not part of
25       * its name.
26       *
27       * @return the parameter name.
28       */
29      String   parameterName();
30  
31      /**
32       * Return the parameter comment
33       * associated with this <code>ParamTag</code>.
34       *
35       * @return the parameter comment.
36       */
37      String   parameterComment();
38  
39      /**
40       * Return true if this <code>ParamTag</code> corresponds to a type
41       * parameter.  Return false if it corresponds to an ordinary parameter
42       * of a method or constructor.
43       *
44       * @return true if this <code>ParamTag</code> corresponds to a type
45       * parameter.
46       * @since 1.5
47       */
48      boolean isTypeParameter();
49  }
50

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags