summaryrefslogtreecommitdiff
path: root/docs/refman/templates/func.mustache
diff options
context:
space:
mode:
authorDaniel Mensinger <daniel@mensinger-ka.de>2021-08-21 16:26:07 +0200
committerDaniel Mensinger <daniel@mensinger-ka.de>2021-10-03 11:46:34 +0200
commit476b93fd74ac8f7890ffb8d451de5ddc7be5f5c6 (patch)
tree4fb6ff91edd3ba100b85e3998a512958901f4de4 /docs/refman/templates/func.mustache
parent955a29a92d93b3aa09f49e5217be6c1304fc5fbe (diff)
downloadmeson-476b93fd74ac8f7890ffb8d451de5ddc7be5f5c6.tar.gz
docs: Added Markdown generator
Diffstat (limited to 'docs/refman/templates/func.mustache')
-rw-r--r--docs/refman/templates/func.mustache55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/refman/templates/func.mustache b/docs/refman/templates/func.mustache
new file mode 100644
index 000000000..3e6209fc8
--- /dev/null
+++ b/docs/refman/templates/func.mustache
@@ -0,0 +1,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}}