com.whitestein.lsps.lang.doc

Class DocParam

java.lang.Object

com.whitestein.lsps.lang.doc.DocParam

public class DocParam
extends Object

Documentation of a parameter. Thic class allows to obtain detailed information about a method parameter.

Author:

jsa

Constructor Summary

Constructors

Constructor and Description
DocParam(String name, DocText description) Creates a new parameter description.

Method Summary

Modifier and Type	Method and Description
DocText	getDescription() Gets the parameter description.
String	getName() Gets the parameter name.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocParam

public DocParam(String name,
                DocText description)

Creates a new parameter description.

Parameters:

name - the parameter name

description - the parameter description

Method Detail

getName

public String getName()

Gets the parameter name.

Returns:

the parameter name

getDescription

public DocText getDescription()

Gets the parameter description.

Returns:

the parameter description

toString

public String toString()

Overrides:

toString in class Object