From 860d17b6876822ef7023fdce70c725d3f8be37b1 Mon Sep 17 00:00:00 2001
From: jsmall-nvidia <jsmall@nvidia.com>
Date: Fri, 5 Mar 2021 14:34:46 -0500
Subject: Doc tooling improvements (#1734)

* #include an absolute path didn't work - because paths were taken to always be relative.

* Split out AST 'printing'.

* Replace listener with List<Section>

* Section -> Part.

* Kind -> Type Flags -> Kind for ASTPrinter::Part

* Improve comments around ASTPrinter.

* toString -> toText on Val derived types. toText appends to a StringBuilder.

* Added toSlice free function.
Added operator<< for Val derived types.
Use << where appropriate in doing toText.

* More work at mark down output.

* Fill in sourceloc for enum case.
Add more sophisticated location determination for EnumCase.
Refactored documentation output into DocMarkdownWriter.

* Improvements for sig output.

* Split up slang-doc into extractor and writer.

* WIP generic support for doc support.

* Some refactoring to make DocExtractor have potential to be used without Decls.

* Made doc extraction work without Decls.

* Output generic parameters.

* Add generic parameter extraction.

* Added writing variables.

* Add an interface test.

* Fix toArray.

* Support for extensions, and inheritance.

* Disable the doc test.

Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
---
 build/visual-studio/slang/slang.vcxproj         |  6 ++++--
 build/visual-studio/slang/slang.vcxproj.filters | 10 ++++++++--
 2 files changed, 12 insertions(+), 4 deletions(-)

(limited to 'build/visual-studio')

diff --git a/build/visual-studio/slang/slang.vcxproj b/build/visual-studio/slang/slang.vcxproj
index e2d91ea76..fde2307af 100644
--- a/build/visual-studio/slang/slang.vcxproj
+++ b/build/visual-studio/slang/slang.vcxproj
@@ -207,7 +207,8 @@
     <ClInclude Include="..\..\..\source\slang\slang-compiler.h" />
     <ClInclude Include="..\..\..\source\slang\slang-diagnostic-defs.h" />
     <ClInclude Include="..\..\..\source\slang\slang-diagnostics.h" />
-    <ClInclude Include="..\..\..\source\slang\slang-doc.h" />
+    <ClInclude Include="..\..\..\source\slang\slang-doc-extractor.h" />
+    <ClInclude Include="..\..\..\source\slang\slang-doc-mark-down.h" />
     <ClInclude Include="..\..\..\source\slang\slang-emit-c-like.h" />
     <ClInclude Include="..\..\..\source\slang\slang-emit-cpp.h" />
     <ClInclude Include="..\..\..\source\slang\slang-emit-cuda.h" />
@@ -337,7 +338,8 @@
     <ClCompile Include="..\..\..\source\slang\slang-check.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-compiler.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-diagnostics.cpp" />
-    <ClCompile Include="..\..\..\source\slang\slang-doc.cpp" />
+    <ClCompile Include="..\..\..\source\slang\slang-doc-extractor.cpp" />
+    <ClCompile Include="..\..\..\source\slang\slang-doc-mark-down.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-dxc-support.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-emit-c-like.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-emit-cpp.cpp" />
diff --git a/build/visual-studio/slang/slang.vcxproj.filters b/build/visual-studio/slang/slang.vcxproj.filters
index e27409c5d..f11e0369c 100644
--- a/build/visual-studio/slang/slang.vcxproj.filters
+++ b/build/visual-studio/slang/slang.vcxproj.filters
@@ -72,7 +72,10 @@
     <ClInclude Include="..\..\..\source\slang\slang-diagnostics.h">
       <Filter>Header Files</Filter>
     </ClInclude>
-    <ClInclude Include="..\..\..\source\slang\slang-doc.h">
+    <ClInclude Include="..\..\..\source\slang\slang-doc-extractor.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="..\..\..\source\slang\slang-doc-mark-down.h">
       <Filter>Header Files</Filter>
     </ClInclude>
     <ClInclude Include="..\..\..\source\slang\slang-emit-c-like.h">
@@ -458,7 +461,10 @@
     <ClCompile Include="..\..\..\source\slang\slang-diagnostics.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="..\..\..\source\slang\slang-doc.cpp">
+    <ClCompile Include="..\..\..\source\slang\slang-doc-extractor.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="..\..\..\source\slang\slang-doc-mark-down.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
     <ClCompile Include="..\..\..\source\slang\slang-dxc-support.cpp">
-- 
cgit v1.2.3