From c42a9faad8d84f7bd05457d5f8e1fe45d6eecfa2 Mon Sep 17 00:00:00 2001 From: Yong He Date: Tue, 8 Oct 2024 13:29:57 -0700 Subject: Overhaul docgen tool and setup CI to generate stdlib reference. (#5232) * 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. --- tests/doc/doc.slang.expected | 375 ------------------------------------------- 1 file changed, 375 deletions(-) delete mode 100644 tests/doc/doc.slang.expected (limited to 'tests/doc/doc.slang.expected') diff --git a/tests/doc/doc.slang.expected b/tests/doc/doc.slang.expected deleted file mode 100644 index 1163e6485..000000000 --- a/tests/doc/doc.slang.expected +++ /dev/null @@ -1,375 +0,0 @@ -result code = 0 -standard error = { --------------------------------------------------------------------------------- -# `outFunc` - -## Signature - -``` -void outFunc(out int v); -``` - -## Parameters - -* `v` - --------------------------------------------------------------------------------- -# `struct ParentStruct` - -## Description - -Testing out nested generics - -## Generic Parameters - -* `T` Some type - --------------------------------------------------------------------------------- -# `struct ParentStruct.ChildStruct` - -## Description - -Testing out a child - -## Generic Parameters - -* `S` Some other type - -## Methods - -* `getValue` - --------------------------------------------------------------------------------- -# `ParentStruct.ChildStruct.getValue` - -## Description - -A useless method hey ho - -## Signature - -``` -T ParentStruct.ChildStruct.getValue(S v); -``` - -## Parameters - -* `v` - --------------------------------------------------------------------------------- -# `struct GenericStruct` - -## Generic Parameters - -* `T` - -## Fields - -* `value` - -## Methods - -* `getValue` - --------------------------------------------------------------------------------- -# `GenericStruct.getValue` - -## Signature - -``` -T GenericStruct.getValue(); -``` - --------------------------------------------------------------------------------- -# `addInts` - -## Description - -A rather silly generic function to test out doc extraction - -## Signature - -``` -T addInts( - T z, - T b); -``` - -## Parameters - -* `T` The type we are operating on -* `U` Just testing out a non type based generic -* `V` And another one -* `z` CHECKING!! -* `b` The B parameter - --------------------------------------------------------------------------------- -# `Hey::doAnotherThing` - -## Signature - -``` -void Hey::doAnotherThing(int a); -``` - -## Parameters - -* `a` - --------------------------------------------------------------------------------- -# inputBuffer - -``` -RWStructuredBuffer inputBuffer -``` - -## Description - -Let's test indent - -``` -{ - imIndented(); -} -``` - --------------------------------------------------------------------------------- -# `interface IDoThing` - -## Description - -An interface to do things - -# Associated types - -* _V_ An associated type - - -## Methods - -* `add` -* `sub` - --------------------------------------------------------------------------------- -# `IDoThing.add` - -## Description - -Add two integers - -## Signature - -``` -This.V IDoThing.add( - This.V a, - This.V b); -``` - -## Parameters - -* `a` First parameter -* `b` Second parameter - --------------------------------------------------------------------------------- -# `IDoThing.sub` - -## Description - -Subtract -Multi-line - -## Signature - -``` -int IDoThing.sub( - int a, - int b); -``` - -## Parameters - -* `a` First -* `b` Second - --------------------------------------------------------------------------------- -# `interface IThing` - -## Methods - -* `getValue` - --------------------------------------------------------------------------------- -# `IThing.getValue` - -## Signature - -``` -float IThing.getValue(); -``` - --------------------------------------------------------------------------------- -# `extension float : IThing` - -*Implements:* `IThing` - -## Description - -Implement IThing on float - -## Methods - -* `getValue` - --------------------------------------------------------------------------------- -# `float.getValue` - -## Description - -Just return the float itself! - -## Signature - -``` -float float.getValue(); -``` - --------------------------------------------------------------------------------- -# `struct Thing` - -*Implements:* `IThing`, `IDoThing` - -## Methods - -* `add` -* `sub` -* `getValue` - --------------------------------------------------------------------------------- -# `Thing.add` - -## Signature - -``` -int Thing.add( - int a, - int b); -``` - -## Parameters - -* `a` -* `b` - --------------------------------------------------------------------------------- -# `Thing.sub` - -## Signature - -``` -int Thing.sub( - int a, - int b); -``` - -## Parameters - -* `a` -* `b` - --------------------------------------------------------------------------------- -# `Thing.getValue` - -## Signature - -``` -float Thing.getValue(); -``` - --------------------------------------------------------------------------------- -# `struct SomeStruct` - -## Description - -A struct with some fields - -## Fields - -* `aField` A field -* `anotherField` Multi-line is a thing -* `yetAnother` A field with stuff - -## Methods - -* `getMethod` - --------------------------------------------------------------------------------- -# `SomeStruct.getMethod` - -## Description - -Get a value - -## Signature - -``` -int SomeStruct.getMethod(); -``` - --------------------------------------------------------------------------------- -# enum AnEnum - -## Values - -* _Value_ A value -* _AnotherValue_ Another value With a multi-line comment -## Description - -An enum - --------------------------------------------------------------------------------- -# outputBuffer - -``` -RWStructuredBuffer outputBuffer -``` - -## Description - -An output buffer - --------------------------------------------------------------------------------- -# `doThing` - -## Description - -doThing! - -## Signature - -``` -int doThing( - int a, - int b); -``` - -## Parameters - -* `a` a parameter -* `b` b parameter - --------------------------------------------------------------------------------- -# `computeMain` - -## Signature - -``` -void computeMain(vector dispatchThreadID); -``` - -## Parameters - -* `dispatchThreadID` - -} -standard output = { -} -- cgit v1.2.3