xref: /aosp_15_r20/external/stardoc/test/testdata/attribute_defaults_test/golden.md (revision b2fa42943c124aa9c7163734493fc7a7559681cf)
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3A golden test to verify attribute default values.
4
5<a id="my_rule"></a>
6
7## my_rule
8
9<pre>
10my_rule(<a href="#my_rule-name">name</a>, <a href="#my_rule-a">a</a>, <a href="#my_rule-b">b</a>, <a href="#my_rule-c">c</a>, <a href="#my_rule-d">d</a>, <a href="#my_rule-e">e</a>, <a href="#my_rule-f">f</a>, <a href="#my_rule-g">g</a>, <a href="#my_rule-h">h</a>, <a href="#my_rule-i">i</a>, <a href="#my_rule-j">j</a>, <a href="#my_rule-k">k</a>, <a href="#my_rule-l">l</a>, <a href="#my_rule-m">m</a>, <a href="#my_rule-n">n</a>, <a href="#my_rule-o">o</a>, <a href="#my_rule-p">p</a>, <a href="#my_rule-q">q</a>, <a href="#my_rule-r">r</a>, <a href="#my_rule-s">s</a>, <a href="#my_rule-t">t</a>, <a href="#my_rule-u">u</a>, <a href="#my_rule-v">v</a>, <a href="#my_rule-w">w</a>)
11</pre>
12
13This is my rule. It does stuff.
14
15**ATTRIBUTES**
16
17
18| Name  | Description | Type | Mandatory | Default |
19| :------------- | :------------- | :------------- | :------------- | :------------- |
20| <a id="my_rule-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |  |
21| <a id="my_rule-a"></a>a |  Some bool   | Boolean | optional | <code>False</code> |
22| <a id="my_rule-b"></a>b |  Some int   | Integer | optional | <code>2</code> |
23| <a id="my_rule-c"></a>c |  Some int_list   | List of integers | optional | <code>[0, 1]</code> |
24| <a id="my_rule-d"></a>d |  Some label   | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>//foo:bar</code> |
25| <a id="my_rule-e"></a>e |  Some label_keyed_string_dict   | <a href="https://bazel.build/rules/lib/dict">Dictionary: Label -> String</a> | optional | <code>{"//foo:bar": "hello", "//bar:baz": "goodbye"}</code> |
26| <a id="my_rule-f"></a>f |  Some label_list   | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | <code>["//foo:bar", "//bar:baz"]</code> |
27| <a id="my_rule-g"></a>g |  Some string   | String | optional | <code>""</code> |
28| <a id="my_rule-h"></a>h |  Some string_dict   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | <code>{"animal": "bunny", "color": "orange"}</code> |
29| <a id="my_rule-i"></a>i |  Some string_list   | List of strings | optional | <code>["cat", "dog"]</code> |
30| <a id="my_rule-j"></a>j |  Some string_list_dict   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> List of strings</a> | optional | <code>{"animal": ["cat", "bunny"], "color": ["blue", "orange"]}</code> |
31| <a id="my_rule-k"></a>k |  Some bool   | Boolean | required |  |
32| <a id="my_rule-l"></a>l |  Some int   | Integer | required |  |
33| <a id="my_rule-m"></a>m |  Some int_list   | List of integers | required |  |
34| <a id="my_rule-n"></a>n |  Some label   | <a href="https://bazel.build/concepts/labels">Label</a> | required |  |
35| <a id="my_rule-o"></a>o |  Some label_keyed_string_dict   | <a href="https://bazel.build/rules/lib/dict">Dictionary: Label -> String</a> | required |  |
36| <a id="my_rule-p"></a>p |  Some label_list   | <a href="https://bazel.build/concepts/labels">List of labels</a> | required |  |
37| <a id="my_rule-q"></a>q |  Some string   | String | required |  |
38| <a id="my_rule-r"></a>r |  Some string_dict   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | required |  |
39| <a id="my_rule-s"></a>s |  Some string_list   | List of strings | required |  |
40| <a id="my_rule-t"></a>t |  Some string_list_dict   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> List of strings</a> | required |  |
41| <a id="my_rule-u"></a>u |  -   | String | optional | <code>""</code> |
42| <a id="my_rule-v"></a>v |  -   | <a href="https://bazel.build/concepts/labels">Label</a> | optional | <code>None</code> |
43| <a id="my_rule-w"></a>w |  -   | Integer | optional | <code>0</code> |
44
45
46<a id="my_aspect"></a>
47
48## my_aspect
49
50<pre>
51my_aspect(<a href="#my_aspect-name">name</a>, <a href="#my_aspect-y">y</a>, <a href="#my_aspect-z">z</a>)
52</pre>
53
54This is my aspect. It does stuff.
55
56**ASPECT ATTRIBUTES**
57
58
59| Name | Type |
60| :------------- | :------------- |
61| deps| String |
62| attr_aspect| String |
63
64
65**ATTRIBUTES**
66
67
68| Name  | Description | Type | Mandatory | Default |
69| :------------- | :------------- | :------------- | :------------- | :------------- |
70| <a id="my_aspect-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |   |
71| <a id="my_aspect-y"></a>y |  some string   | String | optional |  <code>"why"</code>   |
72| <a id="my_aspect-z"></a>z |  -   | String | required |   |
73
74
75