diff options
Diffstat (limited to 'docs/stdlib-docgen.md')
| -rw-r--r-- | docs/stdlib-docgen.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/stdlib-docgen.md b/docs/stdlib-docgen.md index 0be3af548..1ccd43052 100644 --- a/docs/stdlib-docgen.md +++ b/docs/stdlib-docgen.md @@ -1,11 +1,11 @@ -# Slang Standard Library Documentation Generation Tool +# Slang Core Module Documentation Generation Tool -Slang's standard library reference (https://shader-slang.com/stdlib-reference) is generated by `slangc` from the source of the standard library. +Slang's core module reference (https://shader-slang.com/stdlib-reference) is generated by `slangc` from the source of the core module. This page covers how `slangc` can be used to generate this documentation. ## Generating Documentation -Follow these steps to generate stdlib reference documentation and view the generated markdown files locally: +Follow these steps to generate the core module reference documentation and view the generated markdown files locally: ``` # clone stdlib-reference repo @@ -36,7 +36,7 @@ You should review the generated markdown file to make sure it is formated correc ## Writing and Updating Documentation -Stdlib documentation is done directly in comments inside `source/slang/*.meta.slang` files. +The core module documentation is done directly in comments inside `source/slang/*.meta.slang` files. A documentation comment should be placed directly above the declaration, either insde a `/** */` comment block, or after `///`. The following directives are allowed in comments: |