From bcb53910875e787773e7b60f31ded3afba3aa843 Mon Sep 17 00:00:00 2001 From: ArielG-NV <159081215+ArielG-NV@users.noreply.github.com> Date: Tue, 20 Aug 2024 20:55:46 -0400 Subject: Exclude synthesized code from code auto documentation system (#4889) * Exclude synthesized code from code auto documentation system Fixes #4888 Changes to exclude synthesized code from code-auto-documentation system * syntax change for cleanup --- source/slang/slang-doc-ast.cpp | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'source/slang/slang-doc-ast.cpp') diff --git a/source/slang/slang-doc-ast.cpp b/source/slang/slang-doc-ast.cpp index 172f31b32..4d35f32be 100644 --- a/source/slang/slang-doc-ast.cpp +++ b/source/slang/slang-doc-ast.cpp @@ -3,6 +3,7 @@ #include "../core/slang-string-util.h" +#include "slang/slang-ast-support-types.h" //#include "slang-ast-builder.h" //#include "slang-ast-print.h" @@ -47,9 +48,14 @@ namespace Slang { } } +bool shouldDocumentDecl(Decl* decl) +{ + return !getText(decl->getName()).startsWith("$__syn") && !decl->hasModifier(); +} + static void _addDeclRec(Decl* decl, List& outDecls) { - if (decl == nullptr) + if (decl == nullptr || !shouldDocumentDecl(decl)) { return; } @@ -109,7 +115,7 @@ SlangResult ASTMarkupUtil::extract(ModuleDecl* moduleDecl, SourceManager* source item.searchStyle = getSearchStyle(decl); // Don't generate documentation for synthesized members. - if (getText(decl->getName()).startsWith("$__syn")) + if (!shouldDocumentDecl(decl)) item.searchStyle = DocMarkupExtractor::SearchStyle::None; } -- cgit v1.2.3