Lines Matching full:documentation

4     <li><a href="#rule-documentation">Rule Documentation</a></li>
5     <li><a href="#provider-documentation">Provider Documentation</a></li>
6     <li><a href="#macro-documentation">Macro / Function Documentation</a></li>
10 When generating documentation, Stardoc parses the `.bzl` file to extract the
11 inline documentation as well as evaluates the Starlark code to determine the
12 types for rule attributes. Stardoc will, by default, generate documentation for
15 symbols for which stardoc generates documentation.
17 <a name="rule-documentation"></a>
18 ## Rule Documentation
20 When generating documentation, Stardoc parses the `.bzl` file to extract the
21 inline documentation as well as evaluates the Starlark code to determine the
25 appear in generated documentation.
30 General rule documentation should be supplied in the `doc` parameter of the
33 Likewise, supply attribute documentation in the `doc` parameter of attribute
40 Example rule documentation.
58 <a name="provider-documentation"></a>
59 ## Provider Documentation
65 General provider documentation can be specified using the `doc` parameter
68 Field-related documentation can be specified by passing a map to the
75 A provider with some really neat documentation.
84 <a name="macro-documentation"></a>
85 ## Macro / Function Documentation
117 Parameters are documented in a special `Args:` section. Begin the documentation
119 colon `:`. The documentation for a parameter can span multiple lines as long as