feat: support the final specifier for classes and class templates, in AsciiDoc and HTML

docs/modules/ROOT/pages/generators.adoc

@@ -258,6 +258,10 @@ When the symbol kind is `record` (e.g., `class`, `struct`, `union`), the symbol
 | `string`
 | The default access level of the record members (e.g., `public`, `private`).
 
+| `isFinal`
+| `bool`
+| Whether the record is final.
+
 | `isTypedef`
 | `bool`
 | Whether the record is a typedef.

include/mrdocs/Metadata/Info/Record.hpp

@@ -353,6 +353,7 @@ tag_invoke(
     tag_invoke(t, io, dynamic_cast<Info const&>(I), domCorpus);
     io.map("tag", I.KeyKind);
     io.map("defaultAccess", getDefaultAccessString(I.KeyKind));
+    io.map("isFinal", I.IsFinal);
     io.map("isTypedef", I.IsTypeDef);
     io.map("bases", dom::LazyArray(I.Bases, domCorpus));
     io.map("derived", dom::LazyArray(I.Derived, domCorpus));

share/mrdocs/addons/generator/common/partials/symbol/signature/record.hbs

@@ -6,6 +6,7 @@
 {{~else~}}
     {{>symbol/name-text symbol ~}}
 {{~/if}}
+{{~#if isFinal}} final{{/if~}}
 {{#unless bases~}}
 {{else if isFriend~}}
 {{else}}
@@ -17,4 +18,11 @@
     {{#unless (eq access ../defaultAccess)}} {{access}}{{/unless~}}
     {{#if isVirtual}} virtual{{/if}} {{>type/declarator type~}}
 {{/each~}}
-{{/unless}}{{#isSeeBelow}} { /* see-below */ }{{/isSeeBelow}};
+{{/unless}}
+{{!-- Unless we are going to show a class body ("{ ... }"), don't add a
+      semicolon if the record is final, because something like `class A
+      final;` is ill-formed (`final` can't be used on a non-defining
+      declaration). Similarly, don't show a semicolon if there are base
+      classes. --}}
+{{~#isSeeBelow}} { /* see-below */ }{{/isSeeBelow~}}
+{{#if (or isSeeBelow (and (not isFinal) (eq (len bases) 0)))}};{{/if}}

test-files/golden-tests/config/auto-relates/derived.adoc

@@ -52,7 +52,7 @@ Declared in `<derived.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 struct A
-    : link:#ABase[ABase];
+    : link:#ABase[ABase]
 ----
 
 === Base Classes
@@ -141,7 +141,7 @@ Declared in `<derived.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 struct AView
-    : link:#ABase[ABase];
+    : link:#ABase[ABase]
 ----
 
 === Base Classes
@@ -194,7 +194,7 @@ Declared in `<derived.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 struct AView2
-    : link:#AView[AView];
+    : link:#AView[AView]
 ----
 
 === Base Classes

test-files/golden-tests/config/auto-relates/derived.html

@@ -60,7 +60,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;derived.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">struct A
-    : <a href="#ABase">ABase</a>;
+    : <a href="#ABase">ABase</a>
 
 </code>
 </pre>
@@ -171,7 +171,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;derived.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">struct AView
-    : <a href="#ABase">ABase</a>;
+    : <a href="#ABase">ABase</a>
 
 </code>
 </pre>
@@ -240,7 +240,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;derived.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">struct AView2
-    : <a href="#AView">AView</a>;
+    : <a href="#AView">AView</a>
 
 </code>
 </pre>

test-files/golden-tests/config/extract-implicit-specializations/base.adoc

@@ -23,7 +23,7 @@ Declared in `<base.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 struct A
-    : link:#B[B];
+    : link:#B[B]
 ----
 
 === Base Classes

test-files/golden-tests/config/extract-implicit-specializations/base.html

@@ -34,7 +34,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;base.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">struct A
-    : <a href="#B">B</a>;
+    : <a href="#B">B</a>
 
 </code>
 </pre>

test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.adoc

@@ -23,7 +23,7 @@ Declared in `<extract‐implicit‐specializations.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 struct A
-    : link:#B-00[B<int>];
+    : link:#B-00[B<int>]
 ----
 
 === Base Classes

test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.html

@@ -34,7 +34,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;extract-implicit-specializations.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">struct A
-    : <a href="#B-00">B&lt;int&gt;</a>;
+    : <a href="#B-00">B&lt;int&gt;</a>
 
 </code>
 </pre>

test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.adoc

@@ -23,7 +23,7 @@ Declared in `<no‐extract‐implicit‐specializations&period
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 struct A
-    : link:#B[B<int>];
+    : link:#B[B<int>]
 ----
 
 === Base Classes

test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.html

@@ -34,7 +34,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;no-extract-implicit-specializations.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">struct A
-    : <a href="#B">B&lt;int&gt;</a>;
+    : <a href="#B">B&lt;int&gt;</a>
 
 </code>
 </pre>

test-files/golden-tests/config/inherit-base-members/base-overload-set.adoc

@@ -24,7 +24,7 @@ Declared in `<base‐overload‐set.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 class Base
-    : public link:#ConstBase[ConstBase];
+    : public link:#ConstBase[ConstBase]
 ----
 
 === Base Classes
@@ -118,7 +118,7 @@ Declared in `<base‐overload‐set.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 class C
-    : public link:#Base[Base];
+    : public link:#Base[Base]
 ----
 
 === Base Classes

test-files/golden-tests/config/inherit-base-members/base-overload-set.html

@@ -35,7 +35,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;base-overload-set.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">class Base
-    : public <a href="#ConstBase">ConstBase</a>;
+    : public <a href="#ConstBase">ConstBase</a>
 
 </code>
 </pre>
@@ -155,7 +155,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;base-overload-set.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">class C
-    : public <a href="#Base">Base</a>;
+    : public <a href="#Base">Base</a>
 
 </code>
 </pre>

test-files/golden-tests/config/inherit-base-members/copy-dependencies.adoc

@@ -34,7 +34,7 @@ Declared in `<copy‐dependencies.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 class base
-    : public link:#base_base[base_base];
+    : public link:#base_base[base_base]
 ----
 
 === Base Classes
@@ -290,7 +290,7 @@ Declared in `<copy‐dependencies.cpp>`
 ----
 class derived
     : public link:#base[base]
-    , public excluded_base;
+    , public excluded_base
 ----
 
 === Base Classes
@@ -441,7 +441,7 @@ Declared in `<copy‐dependencies.cpp>`
 ----
 class private_derived
     : link:#base[base]
-    , excluded_base;
+    , excluded_base
 ----
 
 === Member Functions
@@ -507,7 +507,7 @@ Declared in `<copy‐dependencies.cpp>`
 ----
 class protected_derived
     : protected link:#base[base]
-    , protected excluded_base;
+    , protected excluded_base
 ----
 
 === Member Functions

test-files/golden-tests/config/inherit-base-members/copy-dependencies.html

@@ -42,7 +42,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;copy-dependencies.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">class base
-    : public <a href="#base_base">base_base</a>;
+    : public <a href="#base_base">base_base</a>
 
 </code>
 </pre>
@@ -371,7 +371,7 @@ <h3>Synopsis</h3>
 <pre>
 <code class="source-code cpp">class derived
     : public <a href="#base">base</a>
-    , public excluded_base;
+    , public excluded_base
 
 </code>
 </pre>
@@ -555,7 +555,7 @@ <h3>Synopsis</h3>
 <pre>
 <code class="source-code cpp">class private_derived
     : <a href="#base">base</a>
-    , excluded_base;
+    , excluded_base
 
 </code>
 </pre>
@@ -641,7 +641,7 @@ <h3>Synopsis</h3>
 <pre>
 <code class="source-code cpp">class protected_derived
     : protected <a href="#base">base</a>
-    , protected excluded_base;
+    , protected excluded_base
 
 </code>
 </pre>

test-files/golden-tests/config/inherit-base-members/copy.adoc

@@ -34,7 +34,7 @@ Declared in `<copy.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 class base
-    : public link:#base_base[base_base];
+    : public link:#base_base[base_base]
 ----
 
 === Base Classes
@@ -328,7 +328,7 @@ Declared in `<copy.cpp>`
 ----
 class derived
     : public link:#base[base]
-    , public excluded_base;
+    , public excluded_base
 ----
 
 === Base Classes
@@ -612,7 +612,7 @@ Declared in `<copy.cpp>`
 ----
 class private_derived
     : link:#base[base]
-    , excluded_base;
+    , excluded_base
 ----
 
 === Member Functions
@@ -678,7 +678,7 @@ Declared in `<copy.cpp>`
 ----
 class protected_derived
     : protected link:#base[base]
-    , protected excluded_base;
+    , protected excluded_base
 ----
 
 === Member Functions

test-files/golden-tests/config/inherit-base-members/copy.html

@@ -42,7 +42,7 @@ <h3>Synopsis</h3>
 Declared in <code>&lt;copy.cpp&gt;</code></div>
 <pre>
 <code class="source-code cpp">class base
-    : public <a href="#base_base">base_base</a>;
+    : public <a href="#base_base">base_base</a>
 
 </code>
 </pre>
@@ -419,7 +419,7 @@ <h3>Synopsis</h3>
 <pre>
 <code class="source-code cpp">class derived
     : public <a href="#base">base</a>
-    , public excluded_base;
+    , public excluded_base
 
 </code>
 </pre>
@@ -771,7 +771,7 @@ <h3>Synopsis</h3>
 <pre>
 <code class="source-code cpp">class private_derived
     : <a href="#base">base</a>
-    , excluded_base;
+    , excluded_base
 
 </code>
 </pre>
@@ -857,7 +857,7 @@ <h3>Synopsis</h3>
 <pre>
 <code class="source-code cpp">class protected_derived
     : protected <a href="#base">base</a>
-    , protected excluded_base;
+    , protected excluded_base
 
 </code>
 </pre>

test-files/golden-tests/config/inherit-base-members/never.adoc

@@ -34,7 +34,7 @@ Declared in `<never.cpp>`
 [source,cpp,subs="verbatim,replacements,macros,-callouts"]
 ----
 class base
-    : public link:#base_base[base_base];
+    : public link:#base_base[base_base]
 ----
 
 === Base Classes
@@ -286,7 +286,7 @@ Declared in `<never.cpp>`
 ----
 class derived
     : public link:#base[base]
-    , public excluded_base;
+    , public excluded_base
 ----
 
 === Base Classes
@@ -364,7 +364,7 @@ Declared in `<never.cpp>`
 ----
 class private_derived
     : link:#base[base]
-    , excluded_base;
+    , excluded_base
 ----
 
 === Member Functions
@@ -430,7 +430,7 @@ Declared in `<never.cpp>`
 ----
 class protected_derived
     : protected link:#base[base]
-    , protected excluded_base;
+    , protected excluded_base
 ----
 
 === Member Functions