Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## xjavadoc
Interface XParameter

All Superinterfaces:
  Named, Type

All Known Implementing Classes:
  ParameterImpl

public interface XParameter
extends Type, Named

Author:
  Aslak Hellesøy

Method Summary
`String` | `getDescription()` Gets the description of this parameter.
`XTag` | `getParamTag()` Gets the param tag for this parameter.

Methods inherited from interface xjavadoc.Type
`getDimension, getDimensionAsString, getType`

Methods inherited from interface xjavadoc.Named
`getName`

Method Detail

### getParamTag

    public XTag getParamTag()

  Gets the param tag for this parameter.

  Returns:
    the param tag for this parameter, or null if none is specified.

### getDescription

    public String getDescription()

  Gets the description of this parameter. This is the text in the param tag preceding the first token.

  Returns:
    the description of this parameter, or null if there is no corresponding param tag.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2004 XDoclet Team. All Rights Reserved.