1<!-- Generated with Stardoc: http://skydoc.bazel.build --> 2 3A test that verifies basic user function documentation. 4 5<a id="check_sources"></a> 6 7## check_sources 8 9<pre> 10check_sources(<a href="#check_sources-name">name</a>, <a href="#check_sources-required_param">required_param</a>, <a href="#check_sources-bool_param">bool_param</a>, <a href="#check_sources-srcs">srcs</a>, <a href="#check_sources-string_param">string_param</a>, <a href="#check_sources-int_param">int_param</a>, <a href="#check_sources-dict_param">dict_param</a>, 11 <a href="#check_sources-struct_param">struct_param</a>) 12</pre> 13 14Runs some checks on the given source files. 15 16This rule runs checks on a given set of source files. 17Use `bazel build` to run the check. 18 19 20**PARAMETERS** 21 22 23| Name | Description | Default Value | 24| :------------- | :------------- | :------------- | 25| <a id="check_sources-name"></a>name | A unique name for this rule. | none | 26| <a id="check_sources-required_param"></a>required_param | Use your imagination. | none | 27| <a id="check_sources-bool_param"></a>bool_param | <p align="center"> - </p> | <code>True</code> | 28| <a id="check_sources-srcs"></a>srcs | Source files to run the checks against. | <code>[]</code> | 29| <a id="check_sources-string_param"></a>string_param | <p align="center"> - </p> | <code>""</code> | 30| <a id="check_sources-int_param"></a>int_param | Your favorite number. | <code>2</code> | 31| <a id="check_sources-dict_param"></a>dict_param | <p align="center"> - </p> | <code>{}</code> | 32| <a id="check_sources-struct_param"></a>struct_param | <p align="center"> - </p> | <code>struct(foo = "bar")</code> | 33 34 35<a id="deprecated_do_not_use"></a> 36 37## deprecated_do_not_use 38 39<pre> 40deprecated_do_not_use() 41</pre> 42 43This function is deprecated. 44 45 46**DEPRECATED** 47 48Use literally anything but this function. 49 50 51<a id="returns_a_thing"></a> 52 53## returns_a_thing 54 55<pre> 56returns_a_thing(<a href="#returns_a_thing-name">name</a>) 57</pre> 58 59Returns a suffixed name. 60 61**PARAMETERS** 62 63 64| Name | Description | Default Value | 65| :------------- | :------------- | :------------- | 66| <a id="returns_a_thing-name"></a>name | A unique name for this rule. | none | 67 68**RETURNS** 69 70A suffixed version of the name. 71 72 73<a id="undocumented_function"></a> 74 75## undocumented_function 76 77<pre> 78undocumented_function(<a href="#undocumented_function-a">a</a>, <a href="#undocumented_function-b">b</a>, <a href="#undocumented_function-c">c</a>) 79</pre> 80 81 82 83**PARAMETERS** 84 85 86| Name | Description | Default Value | 87| :------------- | :------------- | :------------- | 88| <a id="undocumented_function-a"></a>a | <p align="center"> - </p> | none | 89| <a id="undocumented_function-b"></a>b | <p align="center"> - </p> | none | 90| <a id="undocumented_function-c"></a>c | <p align="center"> - </p> | none | 91 92 93