aboutsummaryrefslogtreecommitdiff
path: root/docs/templates/func.vm
blob: 50aafe4bf2a5cc49754509ccef618d1f5556051a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#[[#]]# `${funcInfo.functionName}`

<pre>
${util.funcSummary($funcInfo)}
</pre>

${funcInfo.docString}

#[[##]]# Parameters

#if (!$funcInfo.getParameterList().isEmpty())

#foreach ($param in $funcInfo.getParameterList())
<a name="${funcInfo.functionName}-${param.name}"/> **`${param.name}`**
#if(${param.mandatory}) *Required.* #else *Optional.* #end #if(!${param.getDefaultValue().isEmpty()}) *Default is* `${param.getDefaultValue()}`. #end ${param.docString}

#end
#else
No parameters.

#end