com.whitestein.lsps.lang.doc

Class Doc

java.lang.Object

com.whitestein.lsps.lang.doc.Doc

public class Doc
extends Object

A structured documentation of a source code element such as a method or a function.

Author:

jsa

Constructor Summary

Constructors

Constructor and Description
Doc(DocText description, List<DocParam> params, List<DocError> errors, DocText returnDoc) Creates a structured documentation for a source code element.

Method Summary

Modifier and Type	Method and Description
DocText	getDescription() Gets the description of the documented element.
List<DocError>	getErrors() Gets the description of the errors this element can produce.
List<DocParam>	getParams() Gets the descriptions of the element's parameters.
DocText	getReturnDoc() Returns a description of return value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Doc

public Doc(DocText description,
           List<DocParam> params,
           List<DocError> errors,
           DocText returnDoc)

Creates a structured documentation for a source code element.

Parameters:

description - the description of the documented element

params - the description of element's parameters

errors - the description of element's errors

returnDoc - the description of the element's return value

Method Detail

getDescription

public DocText getDescription()

Gets the description of the documented element.

Returns:

the description

getParams

public List<DocParam> getParams()

Gets the descriptions of the element's parameters.

Returns:

the parameter description

getErrors

public List<DocError> getErrors()

Gets the description of the errors this element can produce.

Returns:

a list of error descriptions

getReturnDoc

public DocText getReturnDoc()

Returns a description of return value.

Returns:

the return value description

toString

public String toString()

Overrides:

toString in class Object