aboutsummaryrefslogtreecommitdiff
path: root/stardoc/templates/markdown_tables/func.vm
blob: 5275d0881a0abe4fc6da1e358aceb55999e79e85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<a id="${funcInfo.functionName}"></a>

#[[##]]# ${funcInfo.functionName}

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

${util.htmlEscape($funcInfo.docString)}

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


| Name  | Description | Default Value |
| :------------- | :------------- | :------------- |
#foreach ($param in $funcInfo.getParameterList())
| <a id="${funcInfo.functionName}-${param.name}"></a>$param.name | #if(!$param.docString.isEmpty()) ${util.markdownCellFormat($param.docString)} #else <p align="center"> - </p> #end  | #if(!$param.getDefaultValue().isEmpty()) <code>${util.htmlEscape($param.getDefaultValue())}</code> #else none #end|
#end
#end
#if (!$funcInfo.getReturn().docString.isEmpty())

**RETURNS**

${util.htmlEscape($funcInfo.getReturn().docString)}
#end
#if (!$funcInfo.getDeprecated().docString.isEmpty())

**DEPRECATED**

${util.htmlEscape($funcInfo.getDeprecated().docString)}
#end