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

This was already supported in XML. In this commit, we also remove the
semicolon when that would produce invalid C++ code, e.g. in

class A final;

or

class A : B1, B2;

Instead, "{ /* see-below */ }" is now always followed by a semicolon,
even if the record is final and/or base classes are present.

This closes issue #963.

Author: gennaroprota

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