xref: /aosp_15_r20/external/stardoc/stardoc/templates/markdown_tables/func.vm (revision b2fa42943c124aa9c7163734493fc7a7559681cf) 
1<a id="${funcInfo.functionName}"></a>
2
3#[[##]]# ${funcInfo.functionName}
4
5<pre>
6${util.funcSummary($funcInfo)}
7</pre>
8
9${util.htmlEscape($funcInfo.docString)}
10
11#if (!$funcInfo.getParameterList().isEmpty())
12**PARAMETERS**
13
14
15| Name  | Description | Default Value |
16| :------------- | :------------- | :------------- |
17#foreach ($param in $funcInfo.getParameterList())
18| <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|
19#end
20#end
21#if (!$funcInfo.getReturn().docString.isEmpty())
22
23**RETURNS**
24
25${util.htmlEscape($funcInfo.getReturn().docString)}
26#end
27#if (!$funcInfo.getDeprecated().docString.isEmpty())
28
29**DEPRECATED**
30
31${util.htmlEscape($funcInfo.getDeprecated().docString)}
32#end
33