fix: HTML golden tests

gennaroprota · gennaroprota · commit a622c3ce0be8 · 2025-12-11T19:30:45.000+01:00
diff --git a/include/mrdocs/Metadata/Symbol/Friend.hpp b/include/mrdocs/Metadata/Symbol/Friend.hpp
@@ -48,7 +48,7 @@ struct FriendInfo final
 BOOST_DESCRIBE_STRUCT(
     FriendInfo,
     (),
-    (id, Type)
+    (Type) // `id` intentionally omitted
 )
 
 MRDOCS_DECL
@@ -77,6 +77,7 @@ tag_invoke(
         io.defer("name", [&I, domCorpus]{
             return dom::ValueFrom(I.id, domCorpus).get("name");
         });
+        io.map("symbol", I.id);
     }
     else if (I.Type)
     {
diff --git a/include/mrdocs/Metadata/Symbol/Function.hpp b/include/mrdocs/Metadata/Symbol/Function.hpp
@@ -50,7 +50,7 @@ struct FunctionSymbol final
     Optional<TemplateInfo> Template;
 
     /// The class of function this is
-    FunctionClass Class = FunctionClass::Normal;
+    FunctionClass FuncClass = FunctionClass::Normal;
 
     /** Exception specification for the function.
     */
@@ -148,7 +148,7 @@ struct FunctionSymbol final
 BOOST_DESCRIBE_STRUCT(
     FunctionSymbol,
     (SymbolCommonBase<SymbolKind::Function>),
-    (ReturnType, Params, Template, Class, Noexcept, Requires,
+    (ReturnType, Params, Template, FuncClass, Noexcept, Requires,
      IsVariadic, IsDefaulted, IsExplicitlyDefaulted, IsDeleted,
      IsDeletedAsWritten, IsNoReturn, HasOverrideAttr, HasTrailingReturn,
      IsNodiscard, IsExplicitObjectMemberFunction, Constexpr,
diff --git a/include/mrdocs/Metadata/Symbol/Overloads.hpp b/include/mrdocs/Metadata/Symbol/Overloads.hpp
@@ -26,7 +26,7 @@ struct OverloadsSymbol final
     : SymbolCommonBase<SymbolKind::Overloads>
 {
     /// The class of the functions.
-    FunctionClass Class = FunctionClass::Normal;
+    FunctionClass FuncClass = FunctionClass::Normal;
 
     /// The overloaded operator, if any.
     OperatorKind OverloadedOperator = OperatorKind::None;
@@ -64,7 +64,7 @@ struct OverloadsSymbol final
 BOOST_DESCRIBE_STRUCT(
     OverloadsSymbol,
     (SymbolCommonBase<SymbolKind::Overloads>),
-    (Class, OverloadedOperator, Members) // ReturnType intentionally omitted.
+    (FuncClass, OverloadedOperator, Members) // ReturnType intentionally omitted.
 )
 
 /** Merge overload sets, preserving ordering in `Members`.
diff --git a/include/mrdocs/Metadata/Symbol/SymbolBase.hpp b/include/mrdocs/Metadata/Symbol/SymbolBase.hpp
@@ -180,7 +180,8 @@ struct MRDOCS_VISIBLE Symbol {
 BOOST_DESCRIBE_STRUCT(
     Symbol,
     (),
-    (Name, Loc, Kind, id, Access, Extraction, Parent)
+    (Name, Loc, Kind, id, Access,
+     Extraction, IsCopyFromInherited, Parent) // `doc` intentionally omitted.
 )
 
 //------------------------------------------------
@@ -263,6 +264,7 @@ tag_invoke(
 {
     MRDOCS_ASSERT(domCorpus);
     mapWithDescribe(io, I, domCorpus);
+    io.map("class", std::string("symbol"));
     io.map("isRegular", I.Extraction == ExtractionMode::Regular);
     io.map("isSeeBelow", I.Extraction == ExtractionMode::SeeBelow);
     io.map("isImplementationDefined", I.Extraction == ExtractionMode::ImplementationDefined);
diff --git a/include/mrdocs/Metadata/Symbol/SymbolDescribeMapper.hpp b/include/mrdocs/Metadata/Symbol/SymbolDescribeMapper.hpp
@@ -61,7 +61,7 @@ shouldMapValue(T const& value)
     }
 }
 
-/** Convert member name to a DOM-friendly format.
+/** Convert a member name to the corresponding DOM name.
 
     E.g.:
     - IsVariadic -> isVariadic
@@ -75,10 +75,6 @@ normalizeMemberName(std::string_view name)
     {
         return "constexprKind";
     }
-    else if (name == "Class")
-    {
-        return "functionClass";
-    }
     else if (name == "ReturnType")
     {
         return "return";
@@ -87,26 +83,23 @@ normalizeMemberName(std::string_view name)
     {
         return "exceptionSpec";
     }
-    else if (name == "id")
-    {
-        return "symbol";
-    }
     else if (name == "Explicit")
     {
         return "explicitSpec";
     }
-    else if (name == "Symbol")
-    {
-        return "class";
-    }
     else if (name == "KeyKind")
     {
         return "tag";
     }
+    else if (name == "Class")
+    {
+        return "usingClass";
+    }
     else
     {
         std::string result(name);
-        if (!result.empty()) {
+        if (!result.empty())
+        {
             result.front() = std::tolower(result.front(), std::locale::classic());
         }
         return result;
@@ -139,7 +132,7 @@ mapAllDescribedMembers(
 
 }
 
-/** Automatically map all Boost.Describe'd members of a type to DOM.
+/** Automatically map all Boost.Describe'd members of a type to the DOM.
 
     This replaces the manual `tag_invoke()` implementations with a single
     call that handles all member mappings via reflection.
diff --git a/share/mrdocs/addons/generator/common/partials/symbol/name-text.hbs b/share/mrdocs/addons/generator/common/partials/symbol/name-text.hbs
@@ -11,7 +11,7 @@
 
     See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference
 --}}
-{{~#if (and (eq kind "function") (eq functionClass "conversion"))~}}
+{{~#if (and (eq kind "function") (eq funcClass "conversion"))~}}
     {{! Conversion operator: "operator" and the type declarator ~}}
     operator {{>type/declarator-text return ~}}
 {{~else if (eq kind "guide")~}}
diff --git a/share/mrdocs/addons/generator/common/partials/symbol/name.hbs b/share/mrdocs/addons/generator/common/partials/symbol/name.hbs
@@ -11,7 +11,7 @@
 
     See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference
 --}}
-{{~#if (and (eq kind "function") (eq functionClass "conversion"))~}}
+{{~#if (and (eq kind "function") (eq funcClass "conversion"))~}}
     {{! Conversion operator: "operator" and the type declarator ~}}
     operator {{>type/declarator return ~}}
 {{~else if (eq kind "guide")~}}
diff --git a/share/mrdocs/addons/generator/common/partials/symbol/qualified-name-title.hbs b/share/mrdocs/addons/generator/common/partials/symbol/qualified-name-title.hbs
@@ -23,7 +23,7 @@
 {{~#if (and parent parent.parent)~}}
 {{~> symbol/qualified-name-title parent is-qualified-name-parent=true ~}}{{#if parent.name }}::{{/if}}
 {{~/if~}}
-{{~#if (and (eq kind "function") (eq functionClass "conversion"))~}}
+{{~#if (and (eq kind "function") (eq funcClass "conversion"))~}}
     {{~> symbol/name . ~}}
 {{~else if is-qualified-name-parent ~}}
     {{!~ If this is a parent, we only print it if it really has a name ~}}
diff --git a/share/mrdocs/addons/generator/common/partials/symbol/signature/function.hbs b/share/mrdocs/addons/generator/common/partials/symbol/signature/function.hbs
@@ -12,11 +12,11 @@
 {{/if~}}
 {{#if explicitSpec}}{{explicitSpec}}
 {{/if~}}
-{{#if (eq functionClass "normal")}}{{>type/declarator-prefix return}}
+{{#if (eq funcClass "normal")}}{{>type/declarator-prefix return}}
 {{/if~}}
 {{~#if force-link~}}
 {{>symbol/name symbol }}
-{{~else if (eq functionClass "conversion")~}}
+{{~else if (eq funcClass "conversion")~}}
 {{>symbol/name symbol }}
 {{~else if (contains (arr "explicit" "partial") template.kind)~}}
 {{>symbol/name template.primary ~}}{{>template/args-text args=template.args ~}}
@@ -32,7 +32,7 @@
 {{#if isVolatile}} volatile{{/if~}}
 {{#if refQualifier}} {{refQualifier}}{{/if~}}
 {{#if exceptionSpec}} {{exceptionSpec}}{{/if~}}
-{{#if (eq functionClass "normal")}}{{>type/declarator-suffix return}}{{/if~}}
+{{#if (eq funcClass "normal")}}{{>type/declarator-suffix return}}{{/if~}}
 {{#if requires}}
 
 requires {{requires}}{{/if~}}
diff --git a/share/mrdocs/addons/generator/common/partials/symbol/special-function-suffix.hbs b/share/mrdocs/addons/generator/common/partials/symbol/special-function-suffix.hbs
@@ -15,9 +15,9 @@
 {{#if (eq kind "overloads")~}}
     {{>symbol/special-function-suffix (front members)}}
 {{~else if (eq kind "function")~}}
-    {{#if (eq functionClass "constructor")}}
+    {{#if (eq funcClass "constructor")}}
         {{#>markup/span class="small"}}[constructor]{{/markup/span}}
-    {{~else if (eq functionClass "destructor")~}}
+    {{~else if (eq funcClass "destructor")~}}
         {{#>markup/span class="small"}}[destructor]{{/markup/span}}
     {{~/if~}}
     {{~#if isVirtual~}}
diff --git a/share/mrdocs/addons/generator/html/partials/symbol.html.hbs b/share/mrdocs/addons/generator/html/partials/symbol.html.hbs
@@ -186,7 +186,7 @@
 {{#if symbol.shadowDeclarations}}
 <div>
 {{#> markup/dynamic-level-h level=2 }}Introduced Symbols{{/markup/dynamic-level-h~}}
-{{#if (any_of_by symbol.shadows "doc")}}
+{{#if (any_of_by symbol.shadowDeclarations "doc")}}
 <table>
 <thead>
 <tr>
diff --git a/src/lib/AST/ASTVisitor.cpp b/src/lib/AST/ASTVisitor.cpp
@@ -920,7 +920,7 @@ populate(
         }
     }
 
-    I.Class = toFunctionClass(D->getDeclKind());
+    I.FuncClass = toFunctionClass(D->getDeclKind());
 
     // extract the return type in direct dependency mode
     // if it contains a placeholder type which is
diff --git a/src/lib/CorpusImpl.cpp b/src/lib/CorpusImpl.cpp
@@ -583,7 +583,7 @@ lookupImpl(
                 }
                 else if (component.isConversion())
                 {
-                    MRDOCS_CHECK_OR(M.Class == FunctionClass::Conversion, matchRes);
+                    MRDOCS_CHECK_OR(M.FuncClass == FunctionClass::Conversion, matchRes);
                     MRDOCS_CHECK_OR(component.ConversionType == M.ReturnType, matchRes);
                 }
                 else
diff --git a/src/lib/Gen/xml/XMLWriter.cpp b/src/lib/Gen/xml/XMLWriter.cpp
@@ -187,8 +187,8 @@ writeFunction(
 
     constexpr std::string_view functionTagName = "function";
     tags_.open(functionTagName, {
-        { "class", toString(I.Class),
-            I.Class != FunctionClass::Normal },
+        { "class", toString(I.FuncClass),
+            I.FuncClass != FunctionClass::Normal },
         { "name", I.Name },
         { I.Access },
         { "exception-spec", except_spec,
diff --git a/src/lib/Metadata/Finalizers/BaseMembersFinalizer.cpp b/src/lib/Metadata/Finalizers/BaseMembersFinalizer.cpp
@@ -119,8 +119,8 @@ inheritBaseMembers(
         // Check if we're not attempt to copy a special member function
         if (auto const *funcPtr = otherInfoPtr->asFunctionPtr()) {
           MRDOCS_CHECK_OR_CONTINUE(
-              !is_one_of(funcPtr->Class, {FunctionClass::Constructor,
-                                          FunctionClass::Destructor}));
+              !is_one_of(funcPtr->FuncClass, {FunctionClass::Constructor,
+                                              FunctionClass::Destructor}));
         }
 
         // Check if derived class has a member that shadows the base member
diff --git a/src/lib/Metadata/Finalizers/DocComment/Function.hpp b/src/lib/Metadata/Finalizers/DocComment/Function.hpp
@@ -25,14 +25,14 @@ bool
 isSpecialFunction(FunctionSymbol const& I)
 {
     return
-        I.Class != FunctionClass::Normal ||
+        I.FuncClass != FunctionClass::Normal ||
         I.OverloadedOperator != OperatorKind::None;
 }
 
 bool
 isDefaultConstructor(FunctionSymbol const& I)
 {
-    return I.Class == FunctionClass::Constructor && I.Params.empty();
+    return I.FuncClass == FunctionClass::Constructor && I.Params.empty();
 }
 
 template <bool move, bool assignment>
@@ -41,7 +41,7 @@ isCopyOrMoveConstructorOrAssignment(FunctionSymbol const& I)
 {
     if constexpr (!assignment)
     {
-        MRDOCS_CHECK_OR(I.Class == FunctionClass::Constructor, false);
+        MRDOCS_CHECK_OR(I.FuncClass == FunctionClass::Constructor, false);
     }
     else
     {
@@ -122,7 +122,7 @@ innermostTypenameString(Polymorphic<Type> const& T)
 bool
 populateFunctionBriefFromClass(FunctionSymbol& I, CorpusImpl const& corpus)
 {
-    switch (I.Class)
+    switch (I.FuncClass)
     {
         case FunctionClass::Normal:
             return false;
@@ -315,7 +315,7 @@ populateFunctionReturnsForSpecial(
     Polymorphic<Type> const& innerR,
     CorpusImpl const& corpus)
 {
-    if (I.Class == FunctionClass::Conversion)
+    if (I.FuncClass == FunctionClass::Conversion)
     {
         if (auto* brief = getInfoBrief(innerR, corpus))
         {
@@ -529,7 +529,7 @@ setCntrOrAssignParamName(
     MRDOCS_CHECK_OR(I.Params.size() == 1, false);
     MRDOCS_CHECK_OR(I.IsRecordMethod, false);
     MRDOCS_CHECK_OR(
-        I.Class == FunctionClass::Constructor ||
+        I.FuncClass == FunctionClass::Constructor ||
         I.OverloadedOperator == OperatorKind::Equal,
         false);
     auto paramNames =
@@ -645,7 +645,7 @@ setCntrOrAssignParamDoc(
     MRDOCS_CHECK_OR(index == 0, false);
     MRDOCS_CHECK_OR(I.IsRecordMethod, false);
     MRDOCS_CHECK_OR(
-        I.Class == FunctionClass::Constructor ||
+        I.FuncClass == FunctionClass::Constructor ||
         I.OverloadedOperator == OperatorKind::Equal,
         false);
 
diff --git a/src/lib/Metadata/Finalizers/DocComment/Overloads.hpp b/src/lib/Metadata/Finalizers/DocComment/Overloads.hpp
@@ -63,7 +63,7 @@ populateOverloadsBriefIfAllSameBrief(OverloadsSymbol& I, Range&& functionsWithBr
 bool
 populateOverloadsFromClass(OverloadsSymbol& I)
 {
-    switch (I.Class)
+    switch (I.FuncClass)
     {
     case FunctionClass::Normal:
         return false;
diff --git a/src/lib/Metadata/Finalizers/DocCommentFinalizer.cpp b/src/lib/Metadata/Finalizers/DocCommentFinalizer.cpp
@@ -832,7 +832,7 @@ generateAutoFunctionMetadata(FunctionSymbol& I) const
             return;
         }
 
-        if (!is_one_of(I.Class, {
+        if (!is_one_of(I.FuncClass, {
             FunctionClass::Constructor,
             FunctionClass::Destructor }) &&
             I.doc->returns.empty())
diff --git a/src/lib/Metadata/Finalizers/SortMembersFinalizer.cpp b/src/lib/Metadata/Finalizers/SortMembersFinalizer.cpp
@@ -37,7 +37,7 @@ struct SymbolIDCompareFn
             std::same_as<FunctionSymbol, InfoTy> ||
             std::same_as<OverloadsSymbol, InfoTy>)
         {
-            return I.Class;
+            return I.FuncClass;
         }
         return std::nullopt;
     }
diff --git a/src/lib/Metadata/Symbol/Function.cpp b/src/lib/Metadata/Symbol/Function.cpp
@@ -369,9 +369,9 @@ merge(FunctionSymbol& I, FunctionSymbol&& Other)
 {
     MRDOCS_ASSERT(canMerge(I, Other));
     merge(I.asInfo(), std::move(Other.asInfo()));
-    if (I.Class == FunctionClass::Normal)
+    if (I.FuncClass == FunctionClass::Normal)
     {
-        I.Class = Other.Class;
+        I.FuncClass = Other.FuncClass;
     }
     I.ReturnType = std::move(Other.ReturnType);
     std::size_t const n = std::min(I.Params.size(), Other.Params.size());
diff --git a/src/lib/Metadata/Symbol/Overloads.cpp b/src/lib/Metadata/Symbol/Overloads.cpp
@@ -48,7 +48,7 @@ addMember(OverloadsSymbol& I, FunctionSymbol const& Member)
         I.Name = Member.Name;
         I.Access = Member.Access;
         I.Extraction = Member.Extraction;
-        I.Class = Member.Class;
+        I.FuncClass = Member.FuncClass;
         I.OverloadedOperator = Member.OverloadedOperator;
         I.ReturnType = Member.ReturnType;
     }
diff --git a/src/lib/Support/LegibleNames.cpp b/src/lib/Support/LegibleNames.cpp
@@ -49,24 +49,24 @@ getUnnamedInfoName(Symbol const& I)
         if (auto const* FI = I.asFunctionPtr())
         {
             // don't use the reserved prefix for overloaded operators
-            if(FI->Class == FunctionClass::Normal &&
+            if(FI->FuncClass == FunctionClass::Normal &&
                 FI->OverloadedOperator != OperatorKind::None)
             {
                 return std::string(getSafeOperatorName(
                     FI->OverloadedOperator, true));
             }
-            func_idx = to_underlying(FI->Class);
+            func_idx = to_underlying(FI->FuncClass);
         }
         if (auto const* FI = I.asOverloadsPtr())
         {
             // don't use the reserved prefix for overloaded operators
-            if(FI->Class == FunctionClass::Normal &&
+            if(FI->FuncClass == FunctionClass::Normal &&
                 FI->OverloadedOperator != OperatorKind::None)
             {
                 return std::string(getSafeOperatorName(
                     FI->OverloadedOperator, true));
             }
-            func_idx = to_underlying(FI->Class);
+            func_idx = to_underlying(FI->FuncClass);
         }
         MRDOCS_ASSERT(func_idx < std::size(func_reserved));
         return std::string(func_reserved[func_idx]);
@@ -219,7 +219,7 @@ class LegibleNames::Impl
                 {
                     // functions can be explicitly specialized,
                     // and can be overloaded
-                    if (t.Class != FunctionClass::Normal ||
+                    if (t.FuncClass != FunctionClass::Normal ||
                         t.OverloadedOperator != OperatorKind::None)
                     {
                         return getUnnamedInfoName(t);

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ struct FriendInfo final`
`48`	`48`	`BOOST_DESCRIBE_STRUCT(`
`49`	`49`	`FriendInfo,`
`50`	`50`	`(),`
`51`		`- (id, Type)`
	`51`	+ (Type) // `id` intentionally omitted
`52`	`52`	`)`
`53`	`53`
`54`	`54`	`MRDOCS_DECL`
`@@ -77,6 +77,7 @@ tag_invoke(`
`77`	`77`	`io.defer("name", [&I, domCorpus]{`
`78`	`78`	`return dom::ValueFrom(I.id, domCorpus).get("name");`
`79`	`79`	`});`
	`80`	`+ io.map("symbol", I.id);`
`80`	`81`	`}`
`81`	`82`	`else if (I.Type)`
`82`	`83`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ shouldMapValue(T const& value)`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`-/** Convert member name to a DOM-friendly format.`
	`64`	`+/** Convert a member name to the corresponding DOM name.`
`65`	`65`
`66`	`66`	`E.g.:`
`67`	`67`	`- IsVariadic -> isVariadic`
`@@ -75,10 +75,6 @@ normalizeMemberName(std::string_view name)`
`75`	`75`	`{`
`76`	`76`	`return "constexprKind";`
`77`	`77`	`}`
`78`		`- else if (name == "Class")`
`79`		`- {`
`80`		`- return "functionClass";`
`81`		`- }`
`82`	`78`	`else if (name == "ReturnType")`
`83`	`79`	`{`
`84`	`80`	`return "return";`
`@@ -87,26 +83,23 @@ normalizeMemberName(std::string_view name)`
`87`	`83`	`{`
`88`	`84`	`return "exceptionSpec";`
`89`	`85`	`}`
`90`		`- else if (name == "id")`
`91`		`- {`
`92`		`- return "symbol";`
`93`		`- }`
`94`	`86`	`else if (name == "Explicit")`
`95`	`87`	`{`
`96`	`88`	`return "explicitSpec";`
`97`	`89`	`}`
`98`		`- else if (name == "Symbol")`
`99`		`- {`
`100`		`- return "class";`
`101`		`- }`
`102`	`90`	`else if (name == "KeyKind")`
`103`	`91`	`{`
`104`	`92`	`return "tag";`
`105`	`93`	`}`
	`94`	`+ else if (name == "Class")`
	`95`	`+ {`
	`96`	`+ return "usingClass";`
	`97`	`+ }`
`106`	`98`	`else`
`107`	`99`	`{`
`108`	`100`	`std::string result(name);`
`109`		`- if (!result.empty()) {`
	`101`	`+ if (!result.empty())`
	`102`	`+ {`
`110`	`103`	`result.front() = std::tolower(result.front(), std::locale::classic());`
`111`	`104`	`}`
`112`	`105`	`return result;`
`@@ -139,7 +132,7 @@ mapAllDescribedMembers(`
`139`	`132`
`140`	`133`	`}`
`141`	`134`
`142`		`-/** Automatically map all Boost.Describe'd members of a type to DOM.`
	`135`	`+/** Automatically map all Boost.Describe'd members of a type to the DOM.`
`143`	`136`
`144`	`137`	This replaces the manual `tag_invoke()` implementations with a single
`145`	`138`	`call that handles all member mappings via reflection.`