uk.ac.starlink.ttools.build

Interface DocletOutput.DocVariable

Enclosing interface:

DocletOutput

public static interface DocletOutput.DocVariable

Characterises a method parameter.

Method Summary

Modifier and Type	Method and Description
String	getCommentText() Returns parameter description.
String	getName() Returns parameter name.
String	getType() Returns parameter type in user-friendly form.

Method Detail

getName

String getName()

Returns parameter name.

Returns:

name

getType

String getType()

Returns parameter type in user-friendly form.

Returns:

type specification

getCommentText

String getCommentText()

Returns parameter description.

Returns:

description, may be HTML