xref: /aosp_15_r20/external/stardoc/test/testdata/angle_bracket_test/golden.md (revision b2fa42943c124aa9c7163734493fc7a7559681cf) 
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3Input file to test &lt;angle bracket bugs&gt;
4
5See https://github.com/bazelbuild/skydoc/issues/186
6and https://github.com/bazelbuild/stardoc/issues/132
7
8<a id="my_anglebrac"></a>
9
10## my_anglebrac
11
12<pre>
13my_anglebrac(<a href="#my_anglebrac-name">name</a>, <a href="#my_anglebrac-useless">useless</a>)
14</pre>
15
16Rule with &lt;brackets&gt;
17
18**ATTRIBUTES**
19
20
21| Name  | Description | Type | Mandatory | Default |
22| :------------- | :------------- | :------------- | :------------- | :------------- |
23| <a id="my_anglebrac-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |  |
24| <a id="my_anglebrac-useless"></a>useless |  Args with some tags: &lt;tag1&gt;, &lt;tag2&gt;   | String | optional | <code>"Find &lt;brackets&gt;"</code> |
25
26
27<a id="bracketuse"></a>
28
29## bracketuse
30
31<pre>
32bracketuse(<a href="#bracketuse-foo">foo</a>, <a href="#bracketuse-bar">bar</a>, <a href="#bracketuse-baz">baz</a>)
33</pre>
34
35Information with &lt;brackets&gt;
36
37**FIELDS**
38
39
40| Name  | Description |
41| :------------- | :------------- |
42| <a id="bracketuse-foo"></a>foo |  A string representing &lt;foo&gt;    |
43| <a id="bracketuse-bar"></a>bar |  A string representing bar    |
44| <a id="bracketuse-baz"></a>baz |  A string representing baz    |
45
46
47<a id="bracket_function"></a>
48
49## bracket_function
50
51<pre>
52bracket_function(<a href="#bracket_function-param">param</a>)
53</pre>
54
55Dummy docstring with &lt;brackets&gt;.
56
57This rule runs checks on &lt;angle brackets&gt;.
58
59
60**PARAMETERS**
61
62
63| Name  | Description | Default Value |
64| :------------- | :------------- | :------------- |
65| <a id="bracket_function-param"></a>param |  an arg with **formatted** docstring, &lt;default&gt; by default.   |  <code>"&lt;default&gt;"</code> |
66
67**RETURNS**
68
69some &lt;angled&gt; brackets
70
71**DEPRECATED**
72
73deprecated for &lt;reasons&gt;
74
75
76<a id="bracket_aspect"></a>
77
78## bracket_aspect
79
80<pre>
81bracket_aspect(<a href="#bracket_aspect-name">name</a>, <a href="#bracket_aspect-brackets">brackets</a>)
82</pre>
83
84Aspect with &lt;brackets&gt;
85
86**ASPECT ATTRIBUTES**
87
88
89| Name | Type |
90| :------------- | :------------- |
91| deps| String |
92
93
94**ATTRIBUTES**
95
96
97| Name  | Description | Type | Mandatory | Default |
98| :------------- | :------------- | :------------- | :------------- | :------------- |
99| <a id="bracket_aspect-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |   |
100| <a id="bracket_aspect-brackets"></a>brackets |  Attribute with &lt;brackets&gt;   | String | optional |  <code>"&lt;default&gt;"</code>   |
101
102
103