From 5bcb342962634e9c36fe399a822e685bb2eb8d76 Mon Sep 17 00:00:00 2001
From: jsmall-nvidia <jsmall@nvidia.com>
Date: Thu, 11 Mar 2021 17:08:08 -0500
Subject: stdlib documentation (#1745)

* #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.

* Added flags to compileStdLib.

* More work around handling generics in markdown output.

* More improvements around associated type handling.

* List method names only once.
Output in/out/inout/const

* Fix namespace printing.

* WIP summarizing doc output.

* Small fixes and improvements for doc output.

* Output all stdlib in single doc file.

* Remove compile flags from addBuiltinSource.

* Find only unique signatures.
First pass at trying to get requirements.

* First pass at requirements for stdlib docs.

* Remove __ function/methods

* Added Target Availability

* Add markup access.
Make sections of stdlib hidden.

* MarkdownAccess -> Visibility
Add isVisible methods
Use ASTPrinter to print decl name.

* Add current stdlib doc output.

* Disable doc test for now.

* Fix clang issue.

* Don't use bullets and numbering , just use numbering.

* Put methods in source order.

* Fix bad-operator-call.slang test that fails because it now outputs out parameters as such.

* Refactor MarkDownWriter to separate 'extraction' from output.

* Fix typo around @ lines.

* Fix issue with extracting 'before' when preceeded by complex attributes/modifiers.

* Fix handling of generics with the same name.

* Work around for having overloading with generics - we don't want to output generic params as part of name.

* Remove generic paramters from name.

* Simplify handling of outputting overridable names.
---
 source/slang/slang-options.cpp | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'source/slang/slang-options.cpp')

diff --git a/source/slang/slang-options.cpp b/source/slang/slang-options.cpp
index fb7ba79c6..ff7923771 100644
--- a/source/slang/slang-options.cpp
+++ b/source/slang/slang-options.cpp
@@ -437,6 +437,8 @@ struct OptionsParser
         // The default archive type is zip
         SlangArchiveType archiveType = SLANG_ARCHIVE_TYPE_ZIP;
 
+        bool compileStdLib = false;
+        slang::CompileStdLibFlags compileStdLibFlags = 0;
         bool hasLoadedRepro = false;
 
         char const* const* argCursor = &argv[0];
@@ -464,7 +466,7 @@ struct OptionsParser
                 }
                 else if (argStr == "-compile-stdlib")
                 {
-                    SLANG_RETURN_ON_FAIL(session->compileStdLib());
+                    compileStdLib = true;
                 }
                 else if (argStr == "-archive-type")
                 {
@@ -533,6 +535,10 @@ struct OptionsParser
                 }
                 else if (argStr == "-doc")
                 {
+                    // If compiling stdlib is enabled, will write out documentation
+                    compileStdLibFlags |= slang::CompileStdLibFlag::WriteDocumentation;
+
+                    // Enable writing out documentation on the req
                     requestImpl->getFrontEndReq()->shouldDocument = true;
                 }
                 else if (argStr == "-dump-repro")
@@ -1109,6 +1115,11 @@ struct OptionsParser
             }
         }
 
+        if (compileStdLib)
+        {
+            SLANG_RETURN_ON_FAIL(session->compileStdLib(compileStdLibFlags));
+        }
+
         // TODO(JS): This is a restriction because of how setting of state works for load repro
         // If a repro has been loaded, then many of the following options will overwrite
         // what was set up. So for now they are ignored, and only parameters set as part
-- 
cgit v1.2.3