org.ballerinalang.docgen.model

Class FunctionDoc

java.lang.Object

org.ballerinalang.docgen.model.Documentable

org.ballerinalang.docgen.model.FunctionDoc

public class FunctionDoc
extends Documentable

Documentable node for Functions.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isFunction
List<Variable>	parameters
List<Variable>	returnParams

Fields inherited from class org.ballerinalang.docgen.model.Documentable

children, description, icon, name

Constructor Summary

Constructors

Constructor and Description
FunctionDoc(String name, String description, ArrayList<Documentable> children, List<Variable> parameters, List<Variable> returnParams) Constructor.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

parameters

public final List<Variable> parameters

returnParams

public final List<Variable> returnParams

isFunction

public final boolean isFunction

Constructor Detail

FunctionDoc

public FunctionDoc(String name,
                   String description,
                   ArrayList<Documentable> children,
                   List<Variable> parameters,
                   List<Variable> returnParams)

Constructor.

Parameters:

name - function name.

description - description.

children - children if any.

parameters - parameters of the function.

returnParams - return parameters of the function.