View Javadoc

    1   /*
    2    * Copyright (c) 2001-2003 The XDoclet team
    3    * All rights reserved.
    4    */
    5   package xjavadoc;
    6
    7   /***
    8    * @author    Aslak Hellesøy
    9    * @created   25. februar 2003
    10   */
    11  public interface XParameter extends Type, Named
    12  {
    13  	/***
    14  	 * Gets the param tag for this parameter.
    15  	 *
    16  	 * @return   the param tag for this parameter, or null if none is specified.
    17  	 */
    18  	XTag getParamTag();
    19
    20  	/***
    21  	 * Gets the description of this parameter. This is the text in the param tag
    22  	 * preceding the first token.
    23  	 *
    24  	 * @return   the description of this parameter, or null if there is no
    25  	 *      corresponding param tag.
    26  	 */
    27  	String getDescription();
    28  }
    29