fix: preserve extraction mode when copying members from derived classes (#1120)

mizvekov · web-flow · commit c406d57aac0b · 2025-12-03T13:15:16.000-03:00
Fixes #1119
diff --git a/include/mrdocs/Metadata/Symbol/SymbolBase.hpp b/include/mrdocs/Metadata/Symbol/SymbolBase.hpp
@@ -71,6 +71,11 @@ struct MRDOCS_VISIBLE Symbol {
     */
     ExtractionMode Extraction = ExtractionMode::Dependency;
 
+    /** Whether this a copy of an inherited method, as produced when
+        `inherit-base-members` is not `never`.
+    */
+    bool IsCopyFromInherited = false;
+
     /** The parent symbol, if any.
 
         This is the parent namespace or record
diff --git a/src/lib/Metadata/Finalizers/BaseMembersFinalizer.cpp b/src/lib/Metadata/Finalizers/BaseMembersFinalizer.cpp
@@ -172,6 +172,7 @@ inheritBaseMembers(
             otherCopy->id = SymbolID::createFromString(
                 std::format("{}-{}", toBase16Str(otherCopy->Parent),
                             toBase16Str(otherInfo.id)));
+            otherCopy->IsCopyFromInherited = true;
             derived.push_back(otherCopy->id);
             // Get the extraction mode from the derived class
             if (otherCopy->Extraction == ExtractionMode::Dependency ||
diff --git a/src/lib/Metadata/Finalizers/DocCommentFinalizer.cpp b/src/lib/Metadata/Finalizers/DocCommentFinalizer.cpp
@@ -1731,7 +1731,8 @@ DocCommentFinalizer::warnUndocumented()
         if (Symbol const* I = corpus_.find(undocI.id))
         {
             MRDOCS_CHECK_OR(
-                !I->doc || I->Extraction == ExtractionMode::Regular);
+                !I->doc || I->Extraction == ExtractionMode::Regular
+                || I->IsCopyFromInherited == false);
         }
         bool const prefer_definition = is_one_of(
             undocI.kind, {SymbolKind::Record, SymbolKind::Enum});
@@ -1752,6 +1753,7 @@ warnDocErrors()
     for (auto const& I : corpus_.info_)
     {
         MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);
+        MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);
         MRDOCS_CHECK_OR_CONTINUE(I->isFunction());
         warnParamErrors(dynamic_cast<FunctionSymbol const&>(*I));
     }
@@ -1807,6 +1809,7 @@ warnNoParamDocs()
     for (auto const& I : corpus_.info_)
     {
         MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);
+        MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);
         MRDOCS_CHECK_OR_CONTINUE(I->isFunction());
         MRDOCS_CHECK_OR_CONTINUE(I->doc);
         warnNoParamDocs(dynamic_cast<FunctionSymbol const&>(*I));
@@ -1869,6 +1872,7 @@ warnUndocEnumValues()
     {
         MRDOCS_CHECK_OR_CONTINUE(I->isEnumConstant());
         MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);
+        MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);
         MRDOCS_CHECK_OR_CONTINUE(!I->doc);
         this->warn(
             *getPrimaryLocation(*I),
@@ -1886,6 +1890,7 @@ warnUnnamedParams()
     {
         MRDOCS_CHECK_OR_CONTINUE(I->isFunction());
         MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);
+        MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);
         MRDOCS_CHECK_OR_CONTINUE(I->doc);
         warnUnnamedParams(dynamic_cast<FunctionSymbol const&>(*I));
     }
diff --git a/test-files/golden-tests/regression/1119.adoc b/test-files/golden-tests/regression/1119.adoc
@@ -0,0 +1,8 @@
+= Reference
+:mrdocs:
+
+[#index]
+== Global namespace
+
+
+[.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/regression/1119.cpp b/test-files/golden-tests/regression/1119.cpp
@@ -0,0 +1,13 @@
+namespace ns {
+struct Foo {
+    /// bar
+    int
+    bar();
+};
+} // namespace ns
+
+/// project namespace
+namespace mrdocs {
+/// Baz
+struct Baz : ns::Foo {};
+} // namespace mrdocs
diff --git a/test-files/golden-tests/regression/1119.html b/test-files/golden-tests/regression/1119.html
@@ -0,0 +1,19 @@
+<html lang="en">
+<head>
+<title>Reference</title>
+</head>
+<body>
+<div>
+<h1>Reference</h1>
+<div>
+<div>
+<h2 id="index"></h2>
+</div>
+</div>
+
+</div>
+<div>
+<h4>Created with <a href="https://www.mrdocs.com">MrDocs</a></h4>
+</div>
+</body>
+</html>
diff --git a/test-files/golden-tests/regression/1119.xml b/test-files/golden-tests/regression/1119.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mrdocs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:noNamespaceSchemaLocation="https://github.com/cppalliance/mrdocs/raw/develop/mrdocs.rnc">
+<namespace id="//////////////////////////8=">
+</namespace>
+</mrdocs>
diff --git a/test-files/golden-tests/regression/1119.yml b/test-files/golden-tests/regression/1119.yml
@@ -0,0 +1,2 @@
+include-symbols:
+  - 'foobar::**'

Original file line number	Diff line number	Diff line change
`@@ -1731,7 +1731,8 @@ DocCommentFinalizer::warnUndocumented()`
`1731`	`1731`	`if (Symbol const* I = corpus_.find(undocI.id))`
`1732`	`1732`	`{`
`1733`	`1733`	`MRDOCS_CHECK_OR(`
`1734`		`- !I->doc \|\| I->Extraction == ExtractionMode::Regular);`
	`1734`	`+ !I->doc \|\| I->Extraction == ExtractionMode::Regular`
	`1735`	`+ \|\| I->IsCopyFromInherited == false);`
`1735`	`1736`	`}`
`1736`	`1737`	`bool const prefer_definition = is_one_of(`
`1737`	`1738`	`undocI.kind, {SymbolKind::Record, SymbolKind::Enum});`
`@@ -1752,6 +1753,7 @@ warnDocErrors()`
`1752`	`1753`	`for (auto const& I : corpus_.info_)`
`1753`	`1754`	`{`
`1754`	`1755`	`MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);`
	`1756`	`+ MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);`
`1755`	`1757`	`MRDOCS_CHECK_OR_CONTINUE(I->isFunction());`
`1756`	`1758`	`warnParamErrors(dynamic_cast<FunctionSymbol const&>(*I));`
`1757`	`1759`	`}`
`@@ -1807,6 +1809,7 @@ warnNoParamDocs()`
`1807`	`1809`	`for (auto const& I : corpus_.info_)`
`1808`	`1810`	`{`
`1809`	`1811`	`MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);`
	`1812`	`+ MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);`
`1810`	`1813`	`MRDOCS_CHECK_OR_CONTINUE(I->isFunction());`
`1811`	`1814`	`MRDOCS_CHECK_OR_CONTINUE(I->doc);`
`1812`	`1815`	`warnNoParamDocs(dynamic_cast<FunctionSymbol const&>(*I));`
`@@ -1869,6 +1872,7 @@ warnUndocEnumValues()`
`1869`	`1872`	`{`
`1870`	`1873`	`MRDOCS_CHECK_OR_CONTINUE(I->isEnumConstant());`
`1871`	`1874`	`MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);`
	`1875`	`+ MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);`
`1872`	`1876`	`MRDOCS_CHECK_OR_CONTINUE(!I->doc);`
`1873`	`1877`	`this->warn(`
`1874`	`1878`	`getPrimaryLocation(I),`
`@@ -1886,6 +1890,7 @@ warnUnnamedParams()`
`1886`	`1890`	`{`
`1887`	`1891`	`MRDOCS_CHECK_OR_CONTINUE(I->isFunction());`
`1888`	`1892`	`MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);`
	`1893`	`+ MRDOCS_CHECK_OR_CONTINUE(I->IsCopyFromInherited == false);`
`1889`	`1894`	`MRDOCS_CHECK_OR_CONTINUE(I->doc);`
`1890`	`1895`	`warnUnnamedParams(dynamic_cast<FunctionSymbol const&>(*I));`
`1891`	`1896`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+include-symbols:`
	`2`	`+ - 'foobar::**'`