slang.git/source/slang/slang-doc-markdown-writer.h, branch masterMaking it easier to work with shadershttps://git.yummers.dev/slang.git/atom?h=master2025-08-07T09:25:42+00:00Add new _getName to get extension decl names for core module docs (#7985)2025-08-07T09:25:42+00:00aidanfnvaidanf@nvidia.com2025-08-07T09:25:42+00:00urn:sha1:67a96920674d628f615532a302504544a45e8187
Fixes #7479
This adds a new variant of `_getName(ExtensionDecl* decl)` to our
markdown doc writer that takes an ExtensionDecl* and returns the name in
the format `extension <name> : <interface>`.
This is required to display "extension T : ITexelElement" properly in
the core module docs, as the existing `_getName(Decl* decl)` returns an
empty string because the name does not come from the `decl` itself, but
rather its `targetType`.
The target type alone is not enough, as that would return `T`, which
will be erroneously interpreted as the name for the generic parameter,
and the doc system will link every mention of `T` to the extension's
page.
ReadTheDocs already displays the name correctly in the TOC of the docs
there, but that is because it falls back to the page title when the name
in the TOC is empty.
---------
Co-authored-by: slangbot <ellieh+slangbot@nvidia.com>
Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com>format2024-10-29T06:49:26+00:00Ellie Hermaszewskaellieh@nvidia.com2024-10-29T06:49:26+00:00urn:sha1:f65d756bff8d4c5cbc15bd0322a2ae8e6b896a21
* format
* Minor test fixes
* enable checking cpp format in ciAdd stdlib documentation for attributes and interfaces. (#5297)2024-10-15T21:21:21+00:00Yong Heyonghe@outlook.com2024-10-15T21:21:21+00:00urn:sha1:ba26c2d7020b41e0d348c7235f86a4232982ab9e
* Add stdlib documentation for attributes and interfaces.
* Fix name mangling to avoid collision of functions in different extensions.
* Fix doc.Write out summary of documentation in docgen tool. (#5266)2024-10-14T17:05:53+00:00Yong Heyonghe@outlook.com2024-10-14T17:05:53+00:00urn:sha1:e57736bdec06246e32f9deea0ad3cc05a433acb1Overhaul docgen tool and setup CI to generate stdlib reference. (#5232)2024-10-08T20:29:57+00:00Yong Heyonghe@outlook.com2024-10-08T20:29:57+00:00urn:sha1:c42a9faad8d84f7bd05457d5f8e1fe45d6eecfa2
* Overhaul docgen tool and setup CI to generate stdlib reference.
* Fix build error.
* Write parsed doc for all decls.
* fix.
* fix callout.
* Fix.
* Fix comment.
* Fix.
* Delete obsolete doc tests.
* Fix.
* Categorize functions and types.
* Fix CI.
* Update comments.Initial support for documentation extraction in C++ (#2156)2022-03-09T23:38:00+00:00jsmall-nvidiajsmall@nvidia.com2022-03-09T23:38:00+00:00urn:sha1:f67d929c24babc302eb2807251fc09b084abac2e
* #include an absolute path didn't work - because paths were taken to always be relative.
* Split doc extractor such that can be used in C++ extractor.
* Compiles. Update the stdlib docs.
* Fix issue on release builds.
* Add support for extracting documentation to C++ extractor.
* Dump out markup.
Make enum value backing type take tokens.
* Node::Type -> Node::Kind
* More improvements around Node::Type -> Node::KindImprovements in Docs requirements/availability (#1751)2021-03-15T15:16:32+00:00jsmall-nvidiajsmall@nvidia.com2021-03-15T15:16:32+00:00urn:sha1:fd304c6c02c73a0024f6d982b1936451e4812370
* #include an absolute path didn't work - because paths were taken to always be relative.
* Use capability system in docs.
Simplify how requirements/availability is produced.
* Small fixes in output of availablity.
* Updated stdlib doc.
* Small improvements.
Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>MarkDown -> Markdown (#1748)2021-03-11T22:56:03+00:00jsmall-nvidiajsmall@nvidia.com2021-03-11T22:56:03+00:00urn:sha1:9ffe2f3ef245034a2dae42017a9059dfe4d02647
* #include an absolute path didn't work - because paths were taken to always be relative.
* MarkDown -> Markdown
slang-doc-mark-down -> slang-doc-markdown-writer