xref: /aosp_15_r20/external/stardoc/test/testdata/input_template_test/golden.md (revision b2fa42943c124aa9c7163734493fc7a7559681cf) 
1<!-- THIS HEADER IS FOR input_template_test ONLY -->
2
3Module Docstring: "Input file for input template test"
4
5<a id="#my_example"></a>
6
7## my_example
8
9<pre>
10my_example(<a href="#my_example-name">name</a>, <a href="#my_example-useless">useless</a>)
11</pre>
12
13Small example of rule using chosen template.
14
15<b>input_template_test BOLD ATTRIBUTES</b>
16
17### Attributes
18
19
20<b>
21      <code>name</code>
22        <a href="https://bazel.build/concepts/labels#target-names">Name</a>; required
23</b>
24        <p>
25          A unique name for this target.
26        </p>
27<b>
28      <code>useless</code>
29        String; optional
30</b>
31        <p>
32          This argument will be ignored.
33        </p>
34
35
36<a id="#example"></a>
37
38## example
39
40<pre>
41example(<a href="#example-foo">foo</a>, <a href="#example-bar">bar</a>, <a href="#example-baz">baz</a>)
42</pre>
43
44Stores information about an example in chosen template.
45
46<b>input_template_test BOLD FIELDS</b>
47
48### Fields
49
50<b>
51      <code>foo</code>
52</b>
53        <p>A string representing foo</p>
54<b>
55      <code>bar</code>
56</b>
57        <p>A string representing bar</p>
58<b>
59      <code>baz</code>
60</b>
61        <p>A string representing baz</p>
62
63
64<a id="#my_aspect_impl"></a>
65
66## my_aspect_impl
67
68<pre>
69my_aspect_impl(<a href="#my_aspect_impl-ctx">ctx</a>)
70</pre>
71
72
73
74<b>input_template_test BOLD PARAMETERS</b>
75
76### Parameters
77
78<b>
79      <code>ctx</code>
80        required.
81
82<a id="#template_function"></a>
83
84## template_function
85
86<pre>
87template_function(<a href="#template_function-foo">foo</a>)
88</pre>
89
90Runs some checks on the given function parameter.
91
92This rule runs checks on a given function parameter in chosen template.
93Use `bazel build` to run the check.
94
95
96<b>input_template_test BOLD PARAMETERS</b>
97
98### Parameters
99
100<b>
101      <code>foo</code>
102        required.        <p>
103          A unique name for this function.
104        </p>
105
106
107<a id="#my_aspect"></a>
108
109## my_aspect
110
111<pre>
112my_aspect(<a href="#my_aspect-name">name</a>, <a href="#my_aspect-first">first</a>)
113</pre>
114
115This is my aspect. It does stuff.
116
117### Aspect Attributes
118
119        deps
120        String; required.
121        attr_aspect
122        String; required.
123
124### Attributes
125
126<b>
127      <code>name</code>
128        <a href="https://bazel.build/concepts/labels#target-names">Name</a>; required
129</b>
130        <p>
131          A unique name for this target.
132        </p>
133<b>
134      <code>first</code>
135        <a href="https://bazel.build/concepts/labels">Label</a>; required
136</b>
137
138
139