• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3Input file for markdown template test
4
5<a id="example_rule"></a>
6
7## example_rule
8
9<pre>
10example_rule(<a href="#example_rule-name">name</a>, <a href="#example_rule-first">first</a>, <a href="#example_rule-second">second</a>)
11</pre>
12
13Small example of rule using a markdown template.
14
15### Attributes
16
17<table class="params-table">
18<colgroup>
19<col class="col-param" />
20<col class="col-description" />
21</colgroup>
22<tbody>
23<tr id="example_rule-name">
24<td><code>name</code></td>
25<td>
26
27<a href="https://bazel.build/concepts/labels#target-names">Name</a>; required
28
29<p>
30
31A unique name for this target.
32
33</p>
34</td>
35</tr>
36<tr id="example_rule-first">
37<td><code>first</code></td>
38<td>
39
40String; optional
41
42<p>
43
44This is the first attribute
45
46</p>
47</td>
48</tr>
49<tr id="example_rule-second">
50<td><code>second</code></td>
51<td>
52
53String; optional
54
55</td>
56</tr>
57</tbody>
58</table>
59
60
61<a id="ExampleProviderInfo"></a>
62
63## ExampleProviderInfo
64
65<pre>
66ExampleProviderInfo(<a href="#ExampleProviderInfo-foo">foo</a>, <a href="#ExampleProviderInfo-bar">bar</a>, <a href="#ExampleProviderInfo-baz">baz</a>)
67</pre>
68
69Small example of provider using a markdown template.
70
71### Fields
72
73<table class="params-table">
74<colgroup>
75<col class="col-param" />
76<col class="col-description" />
77</colgroup>
78<tbody>
79<tr id="ExampleProviderInfo-foo">
80<td><code>foo</code></td>
81<td>
82<p>
83
84A string representing foo
85
86</p>
87</td>
88</tr>
89<tr id="ExampleProviderInfo-bar">
90<td><code>bar</code></td>
91<td>
92<p>
93
94A string representing bar
95
96</p>
97</td>
98</tr>
99<tr id="ExampleProviderInfo-baz">
100<td><code>baz</code></td>
101<td>
102<p>
103
104A string representing baz
105
106</p>
107</td>
108</tr>
109</tbody>
110</table>
111
112
113<a id="example_function"></a>
114
115## example_function
116
117<pre>
118example_function(<a href="#example_function-foo">foo</a>, <a href="#example_function-bar">bar</a>)
119</pre>
120
121Small example of function using a markdown template.
122
123### Parameters
124
125<table class="params-table">
126<colgroup>
127<col class="col-param" />
128<col class="col-description" />
129</colgroup>
130<tbody>
131<tr id="example_function-foo">
132<td><code>foo</code></td>
133<td>
134
135required.
136
137<p>
138
139This parameter does foo related things.
140
141</p>
142</td>
143</tr>
144<tr id="example_function-bar">
145<td><code>bar</code></td>
146<td>
147
148optional.
149default is <code>"bar"</code>
150
151<p>
152
153This parameter does bar related things.
154
155</p>
156</td>
157</tr>
158</tbody>
159</table>
160
161
162<a id="example_aspect"></a>
163
164## example_aspect
165
166<pre>
167example_aspect(<a href="#example_aspect-name">name</a>, <a href="#example_aspect-first">first</a>, <a href="#example_aspect-second">second</a>)
168</pre>
169
170Small example of aspect using a markdown template.
171
172### Aspect Attributes
173
174<table class="params-table">
175<colgroup>
176<col class="col-param" />
177<col class="col-description" />
178</colgroup>
179<tbody>
180<tr id="example_aspect-deps">
181<td><code>deps</code></td>
182<td>
183String; required.
184</td>
185</tr>
186<tr id="example_aspect-attr_aspect">
187<td><code>attr_aspect</code></td>
188<td>
189String; required.
190</td>
191</tr>
192</tbody>
193</table>
194
195### Attributes
196
197<table class="params-table">
198<colgroup>
199<col class="col-param" />
200<col class="col-description" />
201</colgroup>
202<tbody>
203<tr id="example_aspect-name">
204<td><code>name</code></td>
205<td>
206
207<a href="https://bazel.build/concepts/labels#target-names">Name</a>; required
208
209<p>
210
211A unique name for this target.
212
213</p>
214</td>
215</tr>
216<tr id="example_aspect-first">
217<td><code>first</code></td>
218<td>
219
220<a href="https://bazel.build/concepts/labels">Label</a>; required
221
222</td>
223</tr>
224<tr id="example_aspect-second">
225<td><code>second</code></td>
226<td>
227
228String; optional
229
230<p>
231
232This is the second attribute.
233
234</p>
235</td>
236</tr>
237</tbody>
238</table>
239
240
241