xref: /aosp_15_r20/external/stardoc/stardoc/templates/html_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<table class="params-table">
15<colgroup>
16<col class="col-param" />
17<col class="col-description" />
18</colgroup>
19<tbody>
20#foreach ($param in $funcInfo.getParameterList())
21<tr id="${funcInfo.functionName}-${param.name}">
22<td><code>${param.name}</code></td>
23<td>
24
25${util.mandatoryString($param)}.
26#if(!$param.getDefaultValue().isEmpty())
27default is <code>$param.getDefaultValue()</code>
28#end
29
30#if (!$param.docString.isEmpty())
31<p>
32
33${param.docString.trim()}
34
35</p>
36#end
37</td>
38</tr>
39#end
40</tbody>
41</table>
42#end
43#if (!$funcInfo.getReturn().docString.isEmpty())
44
45#[[###]]# Returns
46
47${util.htmlEscape($funcInfo.getReturn().docString)}
48
49#end
50#if (!$funcInfo.getDeprecated().docString.isEmpty())
51
52#[[###]]# Deprecated
53
54${util.htmlEscape($funcInfo.getDeprecated().docString)}
55#end
56