docs/refman/templates/func.mustache


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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

{{base_level}}# {{name}}()

{{&description}}

<p style="padding: 5px; margin: 0px;"></p> <!-- A bit of space because we remove the top margin below -->
<div style="display: flex;">
  <{{signature_level}} style="margin-top: 0px;">Signature</{{signature_level}}>
  <div style="flex-grow: 1;"></div>
  <div>{{>taggs}}</div>
</div>

<pre><code class="language-meson">{{&signature}}</code></pre>

{{#example}}
  <p style="padding: 5px; margin: 0px;"></p> <!-- A bit more space -->

  {{base_level}}## Example

{{&example}}
{{/example}}

{{>notes}}

{{#has_args}}
  <p style="padding: 5px; margin: 0px;"></p> <!-- A bit more space -->

  {{base_level}}## Arguments
{{/has_args}}

{{#posargs}}
  The {{type_name}} `{{name}}()` accepts the following positional arguments:

  {{>args}}

  <p style="padding: 5px; margin: 0px;"></p> <!-- Extra space -->
{{/posargs}}

{{#varargs}}
  {{#posargs}}Additionally, the{{/posargs}}{{^posargs}}The{{/posargs}}
  {{type_name}} accepts between `{{min}}` and `{{max}}` variadic
  arguments (`{{name}}...`) of type <code>{{&type}}</code>.

  {{&description}}

  {{>taggs}}

  <p style="padding: 5px; margin: 0px;"></p> <!-- Extra space -->
{{/varargs}}

{{#kwargs}}
  {{#posargs}}Finally, `{{name}}()`{{/posargs}}{{^posargs}}The {{type_name}} `{{name}}()`{{/posargs}}
  accepts the following keyword arguments:

  {{>args}}
{{/kwargs}}