xref: /aosp_15_r20/external/stardoc/test/testdata/macro_kwargs_test/golden.md (revision b2fa42943c124aa9c7163734493fc7a7559681cf)
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3Tests for functions which use *args or **kwargs
4
5<a id="macro_with_args"></a>
6
7## macro_with_args
8
9<pre>
10macro_with_args(<a href="#macro_with_args-name">name</a>, <a href="#macro_with_args-args">args</a>)
11</pre>
12
13My args macro is OK.
14
15**PARAMETERS**
16
17
18| Name  | Description | Default Value |
19| :------------- | :------------- | :------------- |
20| <a id="macro_with_args-name"></a>name |  The name of the test rule.   |  none |
21| <a id="macro_with_args-args"></a>args |  Other arguments to include   |  none |
22
23**RETURNS**
24
25An empty list.
26
27
28<a id="macro_with_both"></a>
29
30## macro_with_both
31
32<pre>
33macro_with_both(<a href="#macro_with_both-name">name</a>, <a href="#macro_with_both-number">number</a>, <a href="#macro_with_both-args">args</a>, <a href="#macro_with_both-kwargs">kwargs</a>)
34</pre>
35
36Oh wow this macro has both.
37
38Not much else to say.
39
40
41**PARAMETERS**
42
43
44| Name  | Description | Default Value |
45| :------------- | :------------- | :------------- |
46| <a id="macro_with_both-name"></a>name |  The name of the test rule.   |  none |
47| <a id="macro_with_both-number"></a>number |  Some number used for important things   |  <code>3</code> |
48| <a id="macro_with_both-args"></a>args |  Other arguments to include   |  none |
49| <a id="macro_with_both-kwargs"></a>kwargs |  Other attributes to include   |  none |
50
51**RETURNS**
52
53An empty list.
54
55
56<a id="macro_with_kwargs"></a>
57
58## macro_with_kwargs
59
60<pre>
61macro_with_kwargs(<a href="#macro_with_kwargs-name">name</a>, <a href="#macro_with_kwargs-config">config</a>, <a href="#macro_with_kwargs-deps">deps</a>, <a href="#macro_with_kwargs-kwargs">kwargs</a>)
62</pre>
63
64My kwargs macro is the best.
65
66This is a long multi-line doc string.
67Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
68elementum, diam vitae tincidunt pulvinar, nunc tortor volutpat dui,
69vitae facilisis odio ligula a tortor. Donec ullamcorper odio eget ipsum tincidunt,
70vel mollis eros pellentesque.
71
72
73**PARAMETERS**
74
75
76| Name  | Description | Default Value |
77| :------------- | :------------- | :------------- |
78| <a id="macro_with_kwargs-name"></a>name |  The name of the test rule.   |  none |
79| <a id="macro_with_kwargs-config"></a>config |  Config to use for my macro   |  none |
80| <a id="macro_with_kwargs-deps"></a>deps |  List of my macro's dependencies   |  <code>[]</code> |
81| <a id="macro_with_kwargs-kwargs"></a>kwargs |  Other attributes to include   |  none |
82
83**RETURNS**
84
85An empty list.
86
87
88