summaryrefslogtreecommitdiff
path: root/docs/stdlib-docgen.md
AgeCommit message (Collapse)Author
2024-11-29docs: Reduce typo count (#5671)Bruce Mitchener
Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
2024-11-20Clarify stdlib-docgen example (#5619)cheneym2
Add a clarification on the example provided regarding documenting only the first overload. Though the example follows immediately after an existing explanation that only the first overload is present, and that _all_ parameters must be documented there, an extra sentence and the shell of a second overload help drive home the point. Co-authored-by: Yong He <yonghe@outlook.com>
2024-10-25Swap the term StdLib with Core-Module or Standard-Module in documents (#5414)Jay Kwak
This PR is limited to documents. All use of "Standard library" or "StdLib" are replaced with either "core module" or "standard modules", depending on the context.
2024-10-25Replace stdlib on Slang API with CoreModule (#5405)Jay Kwak
This is a breaking change in a way that the Slang API function names are changed. All of them are commented as "experimental" and we wouldn't provide a back-ward compatibility for them. Following functions are renamed: compileStdLib() -> compileCoreModule() loadStdLib() -> loadCoreModule() saveStdLib() -> saveCoreModule() slang_createGlobalSessionWithoutStdLib() -> slang_createGlobalSessionWithoutCoreModule() slang_getEmbeddedStdLib() -> slang_getEmbeddedCoreModule() hasDeferredStdLib() -> hasDeferredCoreModule() Following command-line arguments are renamed: "-load-stdlib" -> "-load-core-module" "-save-stdlib" -> "-save-core-module" "-save-stdlib-bin-source" -> "-save-core-module-bin-source" "-compile-stdlib" -> "-compile-core-module"
2024-10-15Add docgen documentation. (#5318)Yong He