From 55a5ccc559b34b8d2eb9c7b7a2d9efbae40619c2 Mon Sep 17 00:00:00 2001 From: jsmall-nvidia Date: Tue, 23 Feb 2021 12:36:46 -0500 Subject: Documentation markup extraction (#1724) * #include an absolute path didn't work - because paths were taken to always be relative. * WIP extracting source documentation. * WIP doc extraction. * More stuff around doc markup extraction. * More WIP around doc extraction. * Fix some indexing issues. * Initial doc extraction working. * Renaming of types in markup extraction process. * Extracting markup content. Removing indenting. Other fixes and improvements around document tools. * WIP support for documentation system. * Remove some commented out sections. * Remove some comments that no longer apply. * Improvements around SourceFile - such that more granularity around line ops. Made some functionality explicitly work without source. Improved Doc types nameing. --- source/slang/slang.cpp | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'source/slang/slang.cpp') diff --git a/source/slang/slang.cpp b/source/slang/slang.cpp index 14f30c632..e02715015 100644 --- a/source/slang/slang.cpp +++ b/source/slang/slang.cpp @@ -30,6 +30,8 @@ #include "slang-serialize-ir.h" #include "slang-serialize-container.h" +#include "slang-doc.h" + #include "slang-check-impl.h" #include "../../slang-tag-version.h" @@ -1637,6 +1639,26 @@ void FrontEndCompileRequest::parseTranslationUnit( } } + if (shouldDocument) + { + RefPtr markup(new DocMarkup); + markup->extract(translationUnit->getModuleDecl(), getSourceManager(), getSink()); + + // Extract to a file + + const String& path = sourceFile->getPathInfo().foundPath; + if (path.getLength()) + { + String fileName = Path::getFileNameWithoutExt(path); + fileName.append(".md"); + + StringBuilder buf; + DocumentationUtil::writeMarkdown(markup, buf); + + File::writeAllText(fileName, buf); + } + } + #if 0 // Test serialization { -- cgit v1.2.3