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