aboutsummaryrefslogtreecommitdiff
path: root/test/testdata/function_basic_test/golden.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/testdata/function_basic_test/golden.md')
-rwxr-xr-xtest/testdata/function_basic_test/golden.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/test/testdata/function_basic_test/golden.md b/test/testdata/function_basic_test/golden.md
new file mode 100755
index 0000000..0fca193
--- /dev/null
+++ b/test/testdata/function_basic_test/golden.md
@@ -0,0 +1,52 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+<a name="#check_sources"></a>
+
+## check_sources
+
+<pre>
+check_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>,
+ <a href="#check_sources-struct_param">struct_param</a>)
+</pre>
+
+Runs some checks on the given source files.
+
+This rule runs checks on a given set of source files.
+Use `bazel build` to run the check.
+
+
+**PARAMETERS**
+
+
+| Name | Description | Default Value |
+| :-------------: | :-------------: | :-------------: |
+| name | A unique name for this rule. | none |
+| required_param | Use your imagination. | none |
+| bool_param | <p align="center"> - </p> | <code>True</code> |
+| srcs | Source files to run the checks against. | <code>[]</code> |
+| string_param | <p align="center"> - </p> | <code>""</code> |
+| int_param | Your favorite number. | <code>2</code> |
+| dict_param | <p align="center"> - </p> | <code>{}</code> |
+| struct_param | <p align="center"> - </p> | <code>struct(foo = "bar")</code> |
+
+
+<a name="#undocumented_function"></a>
+
+## undocumented_function
+
+<pre>
+undocumented_function(<a href="#undocumented_function-a">a</a>, <a href="#undocumented_function-b">b</a>, <a href="#undocumented_function-c">c</a>)
+</pre>
+
+
+
+**PARAMETERS**
+
+
+| Name | Description | Default Value |
+| :-------------: | :-------------: | :-------------: |
+| a | <p align="center"> - </p> | none |
+| b | <p align="center"> - </p> | none |
+| c | <p align="center"> - </p> | none |
+
+