From 23225637f2cc6f9707aaa727f7fe74ef703453a9 Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Mon, 10 Mar 2025 15:33:43 -0300 Subject: [PATCH] javadoc mapping traits #feat --- include/mrdocs/Metadata/Javadoc.hpp | 795 +++++++++++++++++- include/mrdocs/Support/Algorithm.hpp | 25 +- include/mrdocs/Support/Concepts.hpp | 9 + include/mrdocs/Support/String.hpp | 94 ++- .../adoc/partials/javadoc/admonition.adoc.hbs | 3 + .../adoc/partials/javadoc/code.adoc.hbs | 5 + .../partials/javadoc/detail-blocks.adoc.hbs | 2 + .../adoc/partials/javadoc/heading.adoc.hbs | 3 + .../adoc/partials/javadoc/paragraph.adoc.hbs | 2 + .../partials/javadoc/unordered_list.adoc.hbs | 3 + .../generator/adoc/partials/markup/b.adoc.hbs | 1 + .../generator/adoc/partials/markup/i.adoc.hbs | 1 + .../adoc/partials/markup/span.adoc.hbs | 6 +- .../generator/adoc/partials/symbol.adoc.hbs | 40 +- .../common/partials/javadoc/any-block.hbs | 1 + .../common/partials/javadoc/any-text.hbs | 1 + .../common/partials/javadoc/block.hbs | 1 + .../common/partials/javadoc/brief.hbs | 1 + .../common/partials/javadoc/details.hbs | 1 + .../common/partials/javadoc/link.hbs | 1 + .../common/partials/javadoc/reference.hbs | 5 + .../common/partials/javadoc/returns.hbs | 1 + .../common/partials/javadoc/styled.hbs | 1 + .../common/partials/javadoc/styled/bold.hbs | 1 + .../common/partials/javadoc/styled/italic.hbs | 1 + .../common/partials/javadoc/styled/mono.hbs | 1 + .../common/partials/javadoc/text.hbs | 1 + .../symbol/detail/members-table-row.hbs | 2 +- .../common/partials/symbol/signatures.hbs | 2 +- .../html/partials/javadoc/admonition.html.hbs | 4 + .../html/partials/javadoc/code.html.hbs | 4 + .../partials/javadoc/detail-blocks.html.hbs | 2 + .../html/partials/javadoc/heading.html.hbs | 1 + .../html/partials/javadoc/paragraph.html.hbs | 1 + .../partials/javadoc/unordered_list.html.hbs | 4 + .../generator/html/partials/markup/p.html.hbs | 5 +- .../generator/html/partials/symbol.html.hbs | 33 +- src/lib/AST/ParseJavadoc.cpp | 5 +- src/lib/Gen/adoc/AdocGenerator.cpp | 11 - src/lib/Gen/adoc/AdocGenerator.hpp | 15 +- src/lib/Gen/adoc/DocVisitor.cpp | 349 -------- src/lib/Gen/adoc/DocVisitor.hpp | 103 --- src/lib/Gen/hbs/HandlebarsCorpus.cpp | 208 ----- src/lib/Gen/hbs/HandlebarsCorpus.hpp | 15 +- src/lib/Gen/hbs/HandlebarsGenerator.cpp | 5 +- src/lib/Gen/hbs/HandlebarsGenerator.hpp | 16 +- src/lib/Gen/html/DocVisitor.cpp | 351 -------- src/lib/Gen/html/DocVisitor.hpp | 100 --- src/lib/Gen/html/HTMLGenerator.cpp | 17 +- src/lib/Gen/html/HTMLGenerator.hpp | 15 +- src/lib/Lib/Config.cpp | 10 +- .../Metadata/Finalizers/JavadocFinalizer.cpp | 283 ++++++- .../Metadata/Finalizers/JavadocFinalizer.hpp | 82 ++ src/lib/Metadata/Javadoc.cpp | 157 +++- .../config/auto-brief/auto-brief.adoc | 19 +- .../config/auto-brief/auto-brief.html | 176 ++-- .../config/auto-brief/auto-brief.xml | 15 +- .../config/auto-brief/no-auto-brief.adoc | 19 +- .../config/auto-brief/no-auto-brief.html | 162 ++-- .../config/auto-brief/no-auto-brief.xml | 15 +- .../config/extract-all/no-extract-all.html | 12 +- .../no-extract-empty-namespaces.html | 42 +- .../copy-dependencies.html | 185 ++-- .../config/inherit-base-members/copy.html | 236 ++---- .../config/inherit-base-members/never.html | 98 +-- .../inherit-base-members/reference.html | 149 ++-- .../config/sort/sort-members.html | 28 +- .../golden-tests/config/sort/unordered.html | 28 +- test-files/golden-tests/core/libcxx.adoc | 2 +- test-files/golden-tests/core/libcxx.html | 22 +- test-files/golden-tests/core/libcxx.xml | 6 +- .../filters/file/include-symlink.html | 6 +- .../filters/symbol-name/extraction-mode.html | 234 ++---- .../filters/symbol-name/whitelist_0.html | 102 +-- .../golden-tests/javadoc/brief/brief-1.adoc | 2 +- .../golden-tests/javadoc/brief/brief-1.html | 16 +- .../golden-tests/javadoc/brief/brief-1.xml | 4 +- .../golden-tests/javadoc/brief/brief-2.adoc | 4 +- .../golden-tests/javadoc/brief/brief-2.html | 44 +- .../golden-tests/javadoc/brief/brief-2.xml | 2 +- .../golden-tests/javadoc/brief/brief-3.html | 50 +- .../golden-tests/javadoc/brief/brief-3.xml | 4 +- .../golden-tests/javadoc/brief/brief-5.html | 28 +- .../golden-tests/javadoc/brief/brief-5.xml | 8 - .../golden-tests/javadoc/brief/brief-6.html | 10 +- .../golden-tests/javadoc/code/code.html | 10 +- test-files/golden-tests/javadoc/code/code.xml | 18 +- .../javadoc/copybrief/copybrief.html | 22 +- .../javadoc/copydetails/copydetails.adoc | 8 +- .../javadoc/copydetails/copydetails.html | 124 +-- .../javadoc/copydetails/copydetails.xml | 42 +- .../javadoc/copydoc/conversion.html | 60 +- .../javadoc/copydoc/conversion.xml | 4 +- .../javadoc/copydoc/decay-params.adoc | 8 +- .../javadoc/copydoc/decay-params.html | 76 +- .../javadoc/copydoc/decay-params.xml | 12 +- .../javadoc/copydoc/fundamental.html | 63 +- .../javadoc/copydoc/no-param.adoc | 10 +- .../javadoc/copydoc/no-param.html | 75 +- .../golden-tests/javadoc/copydoc/no-param.xml | 10 +- .../javadoc/copydoc/operator-param.adoc | 4 +- .../javadoc/copydoc/operator-param.html | 50 +- .../javadoc/copydoc/operator-param.xml | 4 +- .../javadoc/copydoc/param-types.adoc | 6 +- .../javadoc/copydoc/param-types.html | 356 +++----- .../javadoc/copydoc/param-types.xml | 12 +- .../javadoc/copydoc/qualified.adoc | 4 +- .../javadoc/copydoc/qualified.html | 225 ++--- .../javadoc/copydoc/qualified.xml | 4 +- .../javadoc/copydoc/qualifiers.adoc | 6 +- .../javadoc/copydoc/qualifiers.html | 132 +-- .../javadoc/copydoc/qualifiers.xml | 6 +- .../javadoc/copydoc/template-arguments.html | 96 +-- .../javadoc/copydoc/template-arguments.xml | 8 +- .../golden-tests/javadoc/inline/styled.adoc | 2 +- .../golden-tests/javadoc/inline/styled.html | 24 +- .../golden-tests/javadoc/inline/styled.xml | 2 +- .../golden-tests/javadoc/link/link.adoc | 46 + test-files/golden-tests/javadoc/link/link.cpp | 7 + .../golden-tests/javadoc/link/link.html | 57 ++ test-files/golden-tests/javadoc/link/link.xml | 19 + test-files/golden-tests/javadoc/lists/li.adoc | 2 +- test-files/golden-tests/javadoc/lists/li.html | 14 +- test-files/golden-tests/javadoc/lists/li.xml | 4 +- .../golden-tests/javadoc/lists/listitem.adoc | 4 +- .../golden-tests/javadoc/lists/listitem.html | 28 +- .../golden-tests/javadoc/lists/listitem.xml | 4 +- .../golden-tests/javadoc/paragraph/par-1.html | 36 +- .../golden-tests/javadoc/paragraph/par-1.xml | 8 +- .../javadoc/paragraph/para-1.html | 20 +- .../javadoc/paragraph/para-2.adoc | 2 +- .../javadoc/paragraph/para-2.html | 10 +- .../golden-tests/javadoc/paragraph/para-2.xml | 2 +- .../javadoc/paragraph/para-3.html | 14 +- .../golden-tests/javadoc/param/param-1.html | 25 +- .../javadoc/param/param-direction.html | 60 +- .../javadoc/param/param-duplicate.html | 72 +- .../javadoc/param/param-duplicate.xml | 8 +- .../golden-tests/javadoc/param/param.html | 28 +- .../golden-tests/javadoc/pre/pre-post.adoc | 2 - .../golden-tests/javadoc/pre/pre-post.html | 11 +- .../golden-tests/javadoc/pre/pre-post.xml | 2 +- .../golden-tests/javadoc/ref/broken-ref.adoc | 8 +- .../golden-tests/javadoc/ref/broken-ref.html | 16 +- .../golden-tests/javadoc/ref/punctuation.adoc | 4 +- .../golden-tests/javadoc/ref/punctuation.html | 10 +- test-files/golden-tests/javadoc/ref/ref.adoc | 108 +-- test-files/golden-tests/javadoc/ref/ref.html | 134 ++- .../golden-tests/javadoc/relates/relates.adoc | 7 - .../golden-tests/javadoc/relates/relates.html | 24 +- .../golden-tests/javadoc/relates/relates.xml | 3 - .../golden-tests/javadoc/throw/throw.html | 9 +- .../golden-tests/javadoc/tparam/tparam-1.html | 17 +- .../golden-tests/snippets/distance.adoc | 2 +- .../golden-tests/snippets/distance.html | 22 +- test-files/golden-tests/snippets/distance.xml | 10 +- .../golden-tests/snippets/is_prime.html | 13 +- test-files/golden-tests/snippets/sqrt.adoc | 2 +- test-files/golden-tests/snippets/sqrt.html | 19 +- test-files/golden-tests/snippets/sqrt.xml | 6 +- .../golden-tests/snippets/terminate.html | 11 +- .../symbols/concept/requires-clause.html | 4 +- .../golden-tests/symbols/enum/enum.html | 44 +- .../golden-tests/symbols/friend/friend-1.html | 12 +- .../golden-tests/symbols/friend/friend-2.html | 12 +- .../golden-tests/symbols/friend/friend-3.html | 12 +- .../golden-tests/symbols/friend/friend-4.html | 12 +- .../golden-tests/symbols/friend/friend-5.html | 6 +- .../golden-tests/symbols/friend/friend-6.html | 44 +- .../symbols/function/explicit-ctor.html | 8 +- .../function/explicit-object-parameter.html | 2 +- .../symbols/function/merge-params.html | 12 +- .../symbols/function/merge-params.xml | 2 +- .../symbols/function/merge-tparams.html | 12 +- .../symbols/function/merge-tparams.xml | 2 +- .../golden-tests/symbols/function/sfinae.html | 92 +- .../symbols/overloads/overloads-brief.adoc | 4 +- .../symbols/overloads/overloads-brief.html | 269 ++---- .../symbols/overloads/overloads-brief.xml | 14 +- .../symbols/overloads/overloads-metadata.adoc | 9 - .../symbols/overloads/overloads-metadata.html | 132 +-- .../symbols/overloads/overloads-metadata.xml | 20 +- .../symbols/overloads/overloads-ostream.html | 4 +- .../symbols/overloads/overloads.html | 8 +- .../golden-tests/symbols/record/record-1.html | 31 +- .../golden-tests/symbols/using/using-3.html | 2 +- .../templates/c_mft_expl_inline.html | 2 +- .../templates/c_mft_expl_outside.html | 2 +- .../templates/ct_mft_expl_inline.html | 2 +- .../templates/ct_mft_expl_outside.html | 2 +- .../golden-tests/templates/ft_expl.html | 2 +- 191 files changed, 3225 insertions(+), 4481 deletions(-) create mode 100644 share/mrdocs/addons/generator/adoc/partials/javadoc/admonition.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/javadoc/code.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/javadoc/detail-blocks.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/javadoc/heading.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/javadoc/paragraph.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/javadoc/unordered_list.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/markup/b.adoc.hbs create mode 100644 share/mrdocs/addons/generator/adoc/partials/markup/i.adoc.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/any-block.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/any-text.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/block.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/brief.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/details.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/link.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/reference.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/returns.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/styled.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/styled/bold.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/styled/italic.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/styled/mono.hbs create mode 100644 share/mrdocs/addons/generator/common/partials/javadoc/text.hbs create mode 100644 share/mrdocs/addons/generator/html/partials/javadoc/admonition.html.hbs create mode 100644 share/mrdocs/addons/generator/html/partials/javadoc/code.html.hbs create mode 100644 share/mrdocs/addons/generator/html/partials/javadoc/detail-blocks.html.hbs create mode 100644 share/mrdocs/addons/generator/html/partials/javadoc/heading.html.hbs create mode 100644 share/mrdocs/addons/generator/html/partials/javadoc/paragraph.html.hbs create mode 100644 share/mrdocs/addons/generator/html/partials/javadoc/unordered_list.html.hbs delete mode 100644 src/lib/Gen/adoc/DocVisitor.cpp delete mode 100644 src/lib/Gen/adoc/DocVisitor.hpp delete mode 100644 src/lib/Gen/html/DocVisitor.cpp delete mode 100644 src/lib/Gen/html/DocVisitor.hpp create mode 100644 test-files/golden-tests/javadoc/link/link.adoc create mode 100644 test-files/golden-tests/javadoc/link/link.cpp create mode 100644 test-files/golden-tests/javadoc/link/link.html create mode 100644 test-files/golden-tests/javadoc/link/link.xml diff --git a/include/mrdocs/Metadata/Javadoc.hpp b/include/mrdocs/Metadata/Javadoc.hpp index 2834cc6935..15f0742022 100644 --- a/include/mrdocs/Metadata/Javadoc.hpp +++ b/include/mrdocs/Metadata/Javadoc.hpp @@ -16,8 +16,11 @@ #include #include #include +#include #include #include +#include +#include #include #include #include @@ -125,6 +128,24 @@ enum class NodeKind postcondition }; +/** Return the name of the NodeKind as a string. + */ +MRDOCS_DECL +dom::String +toString(NodeKind kind) noexcept; + +/** Return the NodeKind from a @ref dom::Value string. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + NodeKind const kind) +{ + v = toString(kind); +} + /** A text style. */ enum class Style @@ -135,6 +156,24 @@ enum class Style italic }; +/** Return the name of the @ref Style as a string. + */ +MRDOCS_DECL +dom::String +toString(Style kind) noexcept; + +/** Return the @ref Style from a @ref dom::Value string. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Style const kind) +{ + v = toString(kind); +} + /** An admonishment style. */ enum class Admonish @@ -147,6 +186,25 @@ enum class Admonish warning }; +/** Return the name of the Admonish as a string. + */ +MRDOCS_DECL +dom::String +toString(Admonish kind) noexcept; + +/** Return the Admonish from a @ref dom::Value string. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Admonish const kind) +{ + v = toString(kind); +} + + /** Parameter pass direction. */ enum class ParamDirection @@ -157,6 +215,24 @@ enum class ParamDirection inout }; +/** Return the name of the ParamDirection as a string. + */ +MRDOCS_DECL +dom::String +toString(ParamDirection kind) noexcept; + +/** Return the ParamDirection from a @ref dom::Value string. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + ParamDirection const kind) +{ + v = toString(kind); +} + /** Which parts of the documentation to copy. @li `all`: copy the brief and the description. @@ -170,6 +246,24 @@ enum class Parts description }; +/** Return the name of the Parts as a string. + */ +MRDOCS_DECL +dom::String +toString(Parts kind) noexcept; + +/** Return the Parts from a @ref dom::Value string. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Parts const kind) +{ + v = toString(kind); +} + //-------------------------------------------- /** This is a variant-like list element. @@ -207,6 +301,53 @@ struct MRDOCS_DECL } }; +/** Map the @ref Node to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag, + IO& io, + Node const& I, + DomCorpus const* domCorpus) +{ + MRDOCS_ASSERT(domCorpus); + io.map("kind", I.Kind); +} + +/** Return the @ref Node as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Node const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + +/** Map the Polymorphic Node as a @ref dom::Value object. + */ +template NodeTy> +void +tag_invoke( + dom::ValueFromTag, + IO& io, + NodeTy const& I, + DomCorpus const* domCorpus) +{ + visit(*I, [&](auto const& U) + { + tag_invoke( + dom::ValueFromTag{}, + io, + U, + domCorpus); + }); +} + //------------------------------------------------ // // Text nodes @@ -256,6 +397,33 @@ struct Text : Node } }; +/** Map the @ref Text to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Text const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("string", I.string); +} + +/** Return the @ref Text as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Text const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + MRDOCS_DECL std::strong_ordering operator<=>(Polymorphic const& lhs, Polymorphic const& rhs); @@ -289,9 +457,36 @@ struct Styled final : Text return Kind == other.Kind && *this == dynamic_cast(other); } - }; +/** Map the @ref Styled to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Styled const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("style", I.style); +} + +/** Return the @ref Styled as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Styled const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + + /** A hyperlink. */ struct Link final : Text @@ -318,6 +513,33 @@ struct Link final : Text } }; +/** Map the @ref Link to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Link const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("href", I.href); +} + +/** Return the @ref Link as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Link const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A reference to a symbol. */ struct Reference : Text @@ -350,6 +572,33 @@ struct Reference : Text } }; +/** Map the @ref Reference to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Reference const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("symbol", I.id); +} + +/** Return the @ref Reference as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Reference const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** Documentation copied from another symbol. */ struct Copied final : Reference @@ -375,6 +624,33 @@ struct Copied final : Reference } }; +/** Map the @ref Copied to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Copied const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("parts", I.parts); +} + +/** Return the @ref Copied as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Copied const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A reference to a related symbol. */ struct Related final : Reference @@ -395,6 +671,32 @@ struct Related final : Reference } }; +/** Map the @ref Related to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Related const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Related as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Related const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + //------------------------------------------------ // // Block nodes @@ -445,8 +747,8 @@ struct MRDOCS_DECL { return false; } - return std::equal(children.begin(), children.end(), - other.children.begin(), other.children.end(), + return std::ranges:: + equal(children, other.children, [](auto const& a, auto const& b) { return a->equals(*b); @@ -484,6 +786,35 @@ struct MRDOCS_DECL Text& emplace_back(Polymorphic text); }; +/** Map the @ref Block to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Block const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.defer("children", [&I, domCorpus] { + return dom::LazyArray(I.children, domCorpus); + }); +} + +/** Return the @ref Block as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Block const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A manually specified section heading. */ struct Heading final : Block @@ -508,6 +839,33 @@ struct Heading final : Block } }; +/** Map the @ref Heading to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Heading const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("string", I.string); +} + +/** Return the @ref Heading as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Heading const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A sequence of text nodes. */ struct Paragraph : Block @@ -537,6 +895,33 @@ struct Paragraph : Block } }; +/** Map the @ref Paragraph to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Paragraph const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Paragraph as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Paragraph const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + + /** The brief description */ struct Brief final : Paragraph @@ -557,6 +942,32 @@ struct Brief final : Paragraph } }; +/** Map the @ref Brief to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Brief const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Brief as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Brief const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** An admonition. This paragraph represents an admonition, such as @@ -584,6 +995,33 @@ struct Admonition final : Paragraph } }; +/** Map the @ref Admonition to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Admonition const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("admonish", I.admonish); +} + +/** Return the @ref Admonition as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Admonition const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** Preformatted source code. */ struct Code final : Paragraph @@ -607,6 +1045,32 @@ struct Code final : Paragraph } }; +/** Map the @ref Code to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Code const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Code as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Code const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** An item in a list */ struct ListItem final : Paragraph @@ -614,7 +1078,7 @@ struct ListItem final : Paragraph static constexpr auto static_kind = NodeKind::list_item; ListItem() - : Paragraph(NodeKind::list_item) + : Paragraph(static_kind) {} auto operator<=>(ListItem const&) const = default; @@ -637,6 +1101,32 @@ struct ListItem final : Paragraph } }; +/** Map the @ref ListItem to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + ListItem const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref ListItem as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + ListItem const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A list of list items */ struct UnorderedList final : Paragraph @@ -646,7 +1136,7 @@ struct UnorderedList final : Paragraph std::vector items; UnorderedList() - : Paragraph(NodeKind::unordered_list) + : Paragraph(static_kind) { } @@ -686,6 +1176,35 @@ struct UnorderedList final : Paragraph } }; +/** Map the @ref UnorderedList to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + UnorderedList const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.defer("items", [&I, domCorpus] { + return dom::LazyArray(I.items, domCorpus); + }); +} + +/** Return the @ref UnorderedList as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + UnorderedList const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A @details paragraph */ struct Details final : Paragraph @@ -716,6 +1235,32 @@ struct Details final : Paragraph } }; +/** Map the @ref Details to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Details const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Details as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Details const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** A @see paragraph */ struct See final : Paragraph @@ -739,6 +1284,32 @@ struct See final : Paragraph } }; +/** Map the @ref See to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + See const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref See as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + See const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** Documentation for a function parameter */ struct Param final : Paragraph @@ -772,6 +1343,33 @@ struct Param final : Paragraph } }; +/** Map the @ref Param to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Param const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("name", I.name); + io.map("direction", I.direction); +} + +/** Return the @ref Param as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Param const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} /** Documentation for a function return type */ @@ -796,6 +1394,32 @@ struct Returns final : Paragraph } }; +/** Map the @ref Returns to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Returns const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Returns as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Returns const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** Documentation for a template parameter */ struct TParam final : Paragraph @@ -818,6 +1442,33 @@ struct TParam final : Paragraph } }; +/** Map the @ref TParam to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + TParam const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("name", I.name); +} + +/** Return the @ref TParam as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + TParam const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + /** Documentation for a function parameter */ struct Throws final : Paragraph @@ -848,6 +1499,33 @@ struct Throws final : Paragraph } }; +/** Map the @ref Throws to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Throws const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); + io.map("exception", I.exception); +} + +/** Return the @ref Throws as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Throws const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + struct Precondition final : Paragraph { static constexpr NodeKind static_kind = NodeKind::precondition; @@ -872,6 +1550,32 @@ struct Precondition final : Paragraph } }; +/** Map the @ref Precondition to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Precondition const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Precondition as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Precondition const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + struct Postcondition : Paragraph { static constexpr auto static_kind = NodeKind::postcondition; @@ -896,6 +1600,32 @@ struct Postcondition : Paragraph } }; +/** Map the @ref Postcondition to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Postcondition const& I, + DomCorpus const* domCorpus) +{ + tag_invoke(t, io, dynamic_cast(I), domCorpus); +} + +/** Return the @ref Postcondition as a @ref dom::Value object. + */ +inline +void +tag_invoke( + dom::ValueFromTag, + dom::Value& v, + Postcondition const& I, + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} + //------------------------------------------------ /** Visit a node. @@ -985,10 +1715,6 @@ void traverse( std::forward(args)...); } -MRDOCS_DECL -dom::String -toString(Style style) noexcept; - } // doc //------------------------------------------------ @@ -1165,16 +1891,61 @@ void merge(Javadoc& I, Javadoc&& other) } } +/** Map the @ref Javadoc to a @ref dom::Object. + */ +template +void +tag_invoke( + dom::LazyObjectMapTag t, + IO& io, + Javadoc const& I, + DomCorpus const* domCorpus) +{ + io.defer("details", [&I, domCorpus] { + return dom::LazyArray(I.blocks, domCorpus); + }); + if (I.brief) + { + io.map("brief", I.brief); + } + io.defer("returns", [&I, domCorpus] { + return dom::LazyArray(I.returns, domCorpus); + }); + io.defer("params", [&I, domCorpus] { + return dom::LazyArray(I.params, domCorpus); + }); + io.defer("tparams", [&I, domCorpus] { + return dom::LazyArray(I.tparams, domCorpus); + }); + io.defer("exceptions", [&I, domCorpus] { + return dom::LazyArray(I.exceptions, domCorpus); + }); + io.defer("sees", [&I, domCorpus] { + return dom::LazyArray(I.sees, domCorpus); + }); + io.defer("related", [&I, domCorpus] { + return dom::LazyArray(I.related, domCorpus); + }); + io.defer("preconditions", [&I, domCorpus] { + return dom::LazyArray(I.preconditions, domCorpus); + }); + io.defer("postconditions", [&I, domCorpus] { + return dom::LazyArray(I.postconditions, domCorpus); + }); +} -/** Return the Javadoc as a @ref dom::Value. +/** Return the @ref Javadoc as a @ref dom::Value object. */ -MRDOCS_DECL +inline void tag_invoke( dom::ValueFromTag, dom::Value& v, Javadoc const& I, - DomCorpus const* domCorpus); + DomCorpus const* domCorpus) +{ + v = dom::LazyObject(I, domCorpus); +} } // clang::mrdocs diff --git a/include/mrdocs/Support/Algorithm.hpp b/include/mrdocs/Support/Algorithm.hpp index 137547f95a..74d3cee9d7 100644 --- a/include/mrdocs/Support/Algorithm.hpp +++ b/include/mrdocs/Support/Algorithm.hpp @@ -32,8 +32,6 @@ contains(Range const& range, El const& el) std::ranges::end(range), el) != std::ranges::end(range); } -// A second overload where the range is an initializer list - /** Determine if a range contains a specific element. @param range The range to search. @param el The element to search for. @@ -49,6 +47,29 @@ contains(std::initializer_list const& range, U const& el) std::ranges::end(range), el) != std::ranges::end(range); } +/** Determine if an element is equal to any of the elements in the specified range. + + @param el The element to search for. + @param range The range to search. + @return True if the element is found, false otherwise. + */ +template +requires std::equality_comparable_with, El> +bool +is_one_of(El const& el, Range const& range) +{ + return contains(range, el); +} + +/// @copydoc is_one_of(El const&, Range const&) +template +requires std::equality_comparable_with +bool +is_one_of(U const& el, std::initializer_list const& range) +{ + return contains(range, el); +} + /** Determine if a range contains any of the specified elements. @param range The range to search. @param els The elements to search for. diff --git a/include/mrdocs/Support/Concepts.hpp b/include/mrdocs/Support/Concepts.hpp index b78f19dbb2..61f976d9a0 100644 --- a/include/mrdocs/Support/Concepts.hpp +++ b/include/mrdocs/Support/Concepts.hpp @@ -38,6 +38,15 @@ concept polymorphic_storage_for = requires(T const& t) { t.operator->() } -> std::convertible_to; }; +/** Determine if a type is dereferenceable + + This concept checks if a type can be dereferenced + to a value it represents and converted to a boolean + value that represents if the object is in a valid state. + + Examples of such types are std::optional, std::unique_ptr, + std::shared_ptr, Polymorphic, pointers, etc. + */ template concept dereferenceable = requires(T const& t) { diff --git a/include/mrdocs/Support/String.hpp b/include/mrdocs/Support/String.hpp index dc17ec96c2..7ebc1dbb89 100644 --- a/include/mrdocs/Support/String.hpp +++ b/include/mrdocs/Support/String.hpp @@ -17,58 +17,72 @@ #include #include -namespace clang { -namespace mrdocs { +namespace clang::mrdocs { + +/** Return the substring without leading specified characters. + */ +constexpr +std::string_view +ltrim( + std::string_view const s, + std::string_view const chars) noexcept +{ + return s.substr(std::min(s.find_first_not_of(chars), s.size())); +} /** Return the substring without leading horizontal whitespace. */ constexpr std::string_view -ltrim(std::string_view s) noexcept +ltrim( + std::string_view const s) noexcept { - auto it = s.begin(); - for (;; ++it) + return ltrim(s, " \t\n\v\f\r"); +} + +/** Return the substring without trailing specified characters. + */ +constexpr +std::string_view +rtrim( + std::string_view const s, + std::string_view const chars) noexcept +{ + auto const pos = s.find_last_not_of(chars); + if (pos == std::string_view::npos) { - if (it == s.end()) - return {}; - if (! std::isspace(*it)) - break; + return s.substr(0, 0); } - return s.substr(it - s.begin()); + return s.substr(0, pos + 1); } /** Return the substring without trailing horizontal whitespace. */ constexpr std::string_view -rtrim(std::string_view s) noexcept +rtrim(std::string_view const s) noexcept { - auto it = s.end() - 1; - while(it > s.begin() && std::isspace(*it)) - { - --it; - } - return s.substr(0, it - s.begin() + 1); + return rtrim(s, " \t\n\v\f\r"); } /** Return the substring without leading and trailing horizontal whitespace. */ constexpr std::string_view -trim(std::string_view s) noexcept +trim(std::string_view const s) noexcept { - auto left = s.begin(); - for (;; ++left) - { - if (left == s.end()) - return {}; - if (!isspace(*left)) - break; - } - auto right = s.end() - 1; - while(right > left && std::isspace(*right)) - --right; - return std::string_view(&*left, right - left + 1); + return rtrim(ltrim(s)); +} + +/** Return the substring without leading and trailing specified characters. + */ +constexpr +std::string_view +trim( + std::string_view const s, + std::string_view const chars) noexcept +{ + return rtrim(ltrim(s, chars), chars); } /** Return the substring without leading and trailing horizontal whitespace. @@ -86,8 +100,24 @@ isWhitespace(std::string_view s) noexcept return s.find_first_not_of(" \t\n\v\f\r") == std::string::npos; } +/** Determine if a string starts with one of the specified characters + */ +constexpr +bool +startsWithOneOf(std::string_view s, std::string_view chars) noexcept +{ + return !s.empty() && chars.find(s.front()) != std::string_view::npos; +} + +/** Determine if a string ends with one of the specified characters + */ +constexpr +bool +endsWithOneOf(std::string_view s, std::string_view chars) noexcept +{ + return !s.empty() && chars.find(s.back()) != std::string_view::npos; +} -} // mrdocs -} // clang +} // clang::mrdocs #endif diff --git a/share/mrdocs/addons/generator/adoc/partials/javadoc/admonition.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/javadoc/admonition.adoc.hbs new file mode 100644 index 0000000000..9e105d3995 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/javadoc/admonition.adoc.hbs @@ -0,0 +1,3 @@ +[{{upper admonish}}] +{{#each children}}{{> javadoc/any-text }}{{/each}} + diff --git a/share/mrdocs/addons/generator/adoc/partials/javadoc/code.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/javadoc/code.adoc.hbs new file mode 100644 index 0000000000..6cfe4e5e83 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/javadoc/code.adoc.hbs @@ -0,0 +1,5 @@ +[,cpp] +---- +{{#each children}}{{> javadoc/any-text verbatim=true }} +{{/each}} +---- diff --git a/share/mrdocs/addons/generator/adoc/partials/javadoc/detail-blocks.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/javadoc/detail-blocks.adoc.hbs new file mode 100644 index 0000000000..f5b40942c3 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/javadoc/detail-blocks.adoc.hbs @@ -0,0 +1,2 @@ +{{#each .}}{{>javadoc/any-block .}}{{/each}} + diff --git a/share/mrdocs/addons/generator/adoc/partials/javadoc/heading.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/javadoc/heading.adoc.hbs new file mode 100644 index 0000000000..ef4366c6c2 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/javadoc/heading.adoc.hbs @@ -0,0 +1,3 @@ + +=== {{string}} + diff --git a/share/mrdocs/addons/generator/adoc/partials/javadoc/paragraph.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/javadoc/paragraph.adoc.hbs new file mode 100644 index 0000000000..9b14154cca --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/javadoc/paragraph.adoc.hbs @@ -0,0 +1,2 @@ +{{#each children}}{{> javadoc/any-text }}{{/each}} + diff --git a/share/mrdocs/addons/generator/adoc/partials/javadoc/unordered_list.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/javadoc/unordered_list.adoc.hbs new file mode 100644 index 0000000000..f832653784 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/javadoc/unordered_list.adoc.hbs @@ -0,0 +1,3 @@ +{{#each items}}* {{> javadoc/block }} +{{/each}} + diff --git a/share/mrdocs/addons/generator/adoc/partials/markup/b.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/markup/b.adoc.hbs new file mode 100644 index 0000000000..dee770c509 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/markup/b.adoc.hbs @@ -0,0 +1 @@ +*{{> @partial-block }}* \ No newline at end of file diff --git a/share/mrdocs/addons/generator/adoc/partials/markup/i.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/markup/i.adoc.hbs new file mode 100644 index 0000000000..0e4c3e2ef3 --- /dev/null +++ b/share/mrdocs/addons/generator/adoc/partials/markup/i.adoc.hbs @@ -0,0 +1 @@ +_{{> @partial-block }}_ \ No newline at end of file diff --git a/share/mrdocs/addons/generator/adoc/partials/markup/span.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/markup/span.adoc.hbs index 9770a5168c..19ad124eaa 100644 --- a/share/mrdocs/addons/generator/adoc/partials/markup/span.adoc.hbs +++ b/share/mrdocs/addons/generator/adoc/partials/markup/span.adoc.hbs @@ -1 +1,5 @@ -{{#if class}}[.{{class}}]#{{/if}}{{> @partial-block }}{{#if class}}#{{/if}} \ No newline at end of file +{{#unless class~}} +{{> @partial-block }} +{{~else~}} +[.{{class}}]#{{> @partial-block }}# +{{~/unless}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs index d5446173e9..f1c0638e61 100644 --- a/share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs +++ b/share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs @@ -19,7 +19,8 @@ {{! Brief }} {{#if symbol.doc.brief}} -{{{symbol.doc.brief}}} +{{> javadoc/brief symbol.doc.brief }} + {{/if}} {{! Synopsis }} @@ -60,7 +61,7 @@ {{else}} |`{{>symbol/name . nolink=true}}` {{/if}} -|{{{~ doc.brief }}} +|{{> javadoc/brief doc.brief }} {{/each}} |=== @@ -77,11 +78,10 @@ {{/if}} {{! Description }} -{{#if symbol.doc.description}} +{{#if symbol.doc.details}} {{#> markup/dynamic-level-h }}Description{{/markup/dynamic-level-h}} -{{{symbol.doc.description}}} - +{{> javadoc/detail-blocks symbol.doc.details }} {{/if}} {{! Using symbols }} {{#if symbol.shadows}} @@ -103,8 +103,8 @@ | Name | Thrown on {{#each symbol.doc.exceptions}} -| `{{exception}}` -| {{{description}}} +| {{> javadoc/reference exception}} +| {{>javadoc/block .}} {{/each}} |=== @@ -115,10 +115,11 @@ {{#> markup/dynamic-level-h }}Return Value{{/markup/dynamic-level-h}} {{#if (eq (size symbol.doc.returns) 1)}} -{{{symbol.doc.returns.[0]}}} +{{> javadoc/returns symbol.doc.returns.[0]}} + {{else}} {{#each symbol.doc.returns}} -* {{{.}}} +* {{> javadoc/returns .}} {{/each}} {{/if}} @@ -132,7 +133,7 @@ {{#each symbol.doc.tparams}} | *{{name}}* -| {{{description}}} +| {{>javadoc/block .}} {{/each}} |=== @@ -147,7 +148,7 @@ {{#each symbol.doc.params}} | *{{name}}*{{#if direction}} [{{direction}}]{{/if}} -| {{{description}}} +| {{>javadoc/block .}} {{/each}} |=== @@ -158,26 +159,33 @@ {{#> markup/dynamic-level-h }}Preconditions{{/markup/dynamic-level-h}} {{#each symbol.doc.preconditions}} -* {{{.}}} +* {{>javadoc/block .}} {{/each}} + + {{/if}} {{! Postconditions }} {{#if symbol.doc.postconditions}} {{#> markup/dynamic-level-h }}Postconditions{{/markup/dynamic-level-h}} {{#each symbol.doc.postconditions}} -* {{{.}}} +* {{>javadoc/block .}} {{/each}} + + {{/if}} {{! See Also }} -{{#if symbol.doc.see}} +{{#if symbol.doc.sees}} {{#> markup/dynamic-level-h }}See Also{{/markup/dynamic-level-h}} -{{#each symbol.doc.see}} -{{{.}}} +{{#each symbol.doc.sees}} +{{>javadoc/block .}} {{/each}} + + + {{/if}} diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/any-block.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/any-block.hbs new file mode 100644 index 0000000000..e232ea71d7 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/any-block.hbs @@ -0,0 +1 @@ +{{> (concat 'javadoc/' kind) }} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/any-text.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/any-text.hbs new file mode 100644 index 0000000000..e232ea71d7 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/any-text.hbs @@ -0,0 +1 @@ +{{> (concat 'javadoc/' kind) }} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/block.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/block.hbs new file mode 100644 index 0000000000..0475cb215a --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/block.hbs @@ -0,0 +1 @@ +{{#>markup/span class=undefined}}{{#each children}}{{>javadoc/any-text }}{{/each}}{{/markup/span}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/brief.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/brief.hbs new file mode 100644 index 0000000000..d19c8494c4 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/brief.hbs @@ -0,0 +1 @@ +{{>javadoc/block}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/details.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/details.hbs new file mode 100644 index 0000000000..c15e968280 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/details.hbs @@ -0,0 +1 @@ +{{>javadoc/paragraph}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/link.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/link.hbs new file mode 100644 index 0000000000..f4fb3636c8 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/link.hbs @@ -0,0 +1 @@ +{{#>markup/a href=href}}{{> javadoc/block }}{{/markup/a}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/reference.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/reference.hbs new file mode 100644 index 0000000000..e1d8772360 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/reference.hbs @@ -0,0 +1,5 @@ +{{#if symbol.url~}} +{{#>markup/a href=symbol.url}}{{#>markup/code}}{{string}}{{/markup/code}}{{/markup/a}} +{{~else~}} +{{#>markup/code}}{{string}}{{/markup/code}} +{{~/if}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/returns.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/returns.hbs new file mode 100644 index 0000000000..d19c8494c4 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/returns.hbs @@ -0,0 +1 @@ +{{>javadoc/block}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/styled.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/styled.hbs new file mode 100644 index 0000000000..1a11bfe15f --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/styled.hbs @@ -0,0 +1 @@ +{{> (concat 'javadoc/styled/' style) }} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/styled/bold.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/styled/bold.hbs new file mode 100644 index 0000000000..2e32e2505f --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/styled/bold.hbs @@ -0,0 +1 @@ +{{#> markup/b }}{{string}}{{/ markup/b }} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/styled/italic.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/styled/italic.hbs new file mode 100644 index 0000000000..63f67e78ee --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/styled/italic.hbs @@ -0,0 +1 @@ +{{#> markup/i }}{{string}}{{/ markup/i }} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/styled/mono.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/styled/mono.hbs new file mode 100644 index 0000000000..291958e658 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/styled/mono.hbs @@ -0,0 +1 @@ +{{#> markup/code }}{{string}}{{/ markup/code }} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/javadoc/text.hbs b/share/mrdocs/addons/generator/common/partials/javadoc/text.hbs new file mode 100644 index 0000000000..c6019f9fa5 --- /dev/null +++ b/share/mrdocs/addons/generator/common/partials/javadoc/text.hbs @@ -0,0 +1 @@ +{{#unless verbatim}}{{string}}{{else}}{{{string}}}{{/unless}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-row.hbs b/share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-row.hbs index a23840ab76..7ebd0f19af 100644 --- a/share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-row.hbs +++ b/share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-row.hbs @@ -13,7 +13,7 @@ {{~/markup/td}} {{#if includeBrief~}} {{~#>markup/td~}} -{{{~doc.brief~}}} +{{~> javadoc/brief doc.brief~}} {{~/markup/td}} {{/if}} diff --git a/share/mrdocs/addons/generator/common/partials/symbol/signatures.hbs b/share/mrdocs/addons/generator/common/partials/symbol/signatures.hbs index b14b7dc2bf..8bdc879ec9 100644 --- a/share/mrdocs/addons/generator/common/partials/symbol/signatures.hbs +++ b/share/mrdocs/addons/generator/common/partials/symbol/signatures.hbs @@ -19,7 +19,7 @@ {{else}} {{#each members as | member |}} -{{#if member.doc.brief}}{{#> markup/p }}{{{member.doc.brief}}}{{/markup/p}}{{/if}} +{{#if member.doc.brief}}{{#> markup/p }}{{> javadoc/brief member.doc.brief }}{{/markup/p}}{{/if}} {{#> markup/code-block }} {{> symbol/signature member link=member}} diff --git a/share/mrdocs/addons/generator/html/partials/javadoc/admonition.html.hbs b/share/mrdocs/addons/generator/html/partials/javadoc/admonition.html.hbs new file mode 100644 index 0000000000..92e022b0cf --- /dev/null +++ b/share/mrdocs/addons/generator/html/partials/javadoc/admonition.html.hbs @@ -0,0 +1,4 @@ +
+

{{upper admonish}}

+

{{#each children}}{{> javadoc/any-text }}{{/each}}

+
\ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/javadoc/code.html.hbs b/share/mrdocs/addons/generator/html/partials/javadoc/code.html.hbs new file mode 100644 index 0000000000..586376c5f4 --- /dev/null +++ b/share/mrdocs/addons/generator/html/partials/javadoc/code.html.hbs @@ -0,0 +1,4 @@ + +{{#each children}}{{> javadoc/any-text verbatim=true }} +{{/each}} + \ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/javadoc/detail-blocks.html.hbs b/share/mrdocs/addons/generator/html/partials/javadoc/detail-blocks.html.hbs new file mode 100644 index 0000000000..2ecb541c2d --- /dev/null +++ b/share/mrdocs/addons/generator/html/partials/javadoc/detail-blocks.html.hbs @@ -0,0 +1,2 @@ +{{#each .}}{{>javadoc/any-block .}} +{{/each}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/javadoc/heading.html.hbs b/share/mrdocs/addons/generator/html/partials/javadoc/heading.html.hbs new file mode 100644 index 0000000000..075f69652f --- /dev/null +++ b/share/mrdocs/addons/generator/html/partials/javadoc/heading.html.hbs @@ -0,0 +1 @@ +

{{string}}

\ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/javadoc/paragraph.html.hbs b/share/mrdocs/addons/generator/html/partials/javadoc/paragraph.html.hbs new file mode 100644 index 0000000000..52e81cd45c --- /dev/null +++ b/share/mrdocs/addons/generator/html/partials/javadoc/paragraph.html.hbs @@ -0,0 +1 @@ +{{#>markup/p}}{{#each children}}{{> javadoc/any-text }}{{/each}}{{/markup/p}} \ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/javadoc/unordered_list.html.hbs b/share/mrdocs/addons/generator/html/partials/javadoc/unordered_list.html.hbs new file mode 100644 index 0000000000..20244bbe0f --- /dev/null +++ b/share/mrdocs/addons/generator/html/partials/javadoc/unordered_list.html.hbs @@ -0,0 +1,4 @@ +
    +{{#each items}}
  • {{> javadoc/block }}
    • +{{/each}} +
\ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/markup/p.html.hbs b/share/mrdocs/addons/generator/html/partials/markup/p.html.hbs index 370b133df1..3600e5a8f7 100644 --- a/share/mrdocs/addons/generator/html/partials/markup/p.html.hbs +++ b/share/mrdocs/addons/generator/html/partials/markup/p.html.hbs @@ -1,4 +1 @@ -

- {{> @partial-block }} - -

+

{{> @partial-block }}

\ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/partials/symbol.html.hbs b/share/mrdocs/addons/generator/html/partials/symbol.html.hbs index 028d595f97..03719aabdd 100644 --- a/share/mrdocs/addons/generator/html/partials/symbol.html.hbs +++ b/share/mrdocs/addons/generator/html/partials/symbol.html.hbs @@ -21,7 +21,8 @@ {{! Brief }} {{#if symbol.doc.brief}}
-{{{symbol.doc.brief}}} +{{> javadoc/brief symbol.doc.brief }} +
{{/if}} @@ -71,7 +72,7 @@ {{else}} {{>symbol/name . nolink=true}} {{/if}} -{{{doc.brief}}} +{{> javadoc/brief doc.brief }} {{/each}} @@ -87,11 +88,10 @@ {{/if}} {{! Description }} -{{#if symbol.doc.description}} +{{#if symbol.doc.details}}
{{#> markup/dynamic-level-h level=2 }}Description{{/markup/dynamic-level-h}} -{{{symbol.doc.description}}} - +{{> javadoc/detail-blocks symbol.doc.details }}
{{/if}} {{! Using symbols }} @@ -129,8 +129,8 @@ {{#each symbol.doc.exceptions}} -{{exception}} -{{{description}}} +{{> javadoc/reference exception}} +{{> javadoc/block .}} {{/each}} @@ -142,11 +142,12 @@
{{#> markup/dynamic-level-h level=2 }}Return Value{{/markup/dynamic-level-h}} {{#if (eq (size symbol.doc.returns) 1)}} -{{{symbol.doc.returns.[0]}}} +{{> javadoc/returns symbol.doc.returns.[0]}} + {{else}}
    {{#each symbol.doc.returns}} -
  • {{{.}}}
    • +
  • {{> javadoc/returns .}}
    • {{/each}}
{{/if}} @@ -167,7 +168,7 @@ {{#each symbol.doc.tparams}} {{name}} -{{{description}}} +{{>javadoc/block .}} {{/each}} @@ -189,7 +190,7 @@ {{#each symbol.doc.params}} {{name}}{{#if direction}} [{{direction}}]{{/if}} -{{{description}}} +{{>javadoc/block .}} {{/each}} @@ -202,7 +203,7 @@ {{#> markup/dynamic-level-h level=2 }}Preconditions{{/markup/dynamic-level-h}}
    {{#each symbol.doc.preconditions}} -
  • {{{.}}}
    • +
  • {{>javadoc/block .}}
    • {{/each}}
@@ -213,17 +214,17 @@ {{#> markup/dynamic-level-h level=2 }}Postconditions{{/markup/dynamic-level-h}}
    {{#each symbol.doc.postconditions}} -
  • {{{.}}}
    • +
  • {{>javadoc/block .}}
    • {{/each}}
{{/if}} {{! See Also }} -{{#if symbol.doc.see}} +{{#if symbol.doc.sees}}
{{#> markup/dynamic-level-h level=2 }}See Also{{/markup/dynamic-level-h}} -{{#each symbol.doc.see}} -

{{{.}}}

+{{#each symbol.doc.sees}} +

{{>javadoc/block .}}

{{/each}}
{{/if}} diff --git a/src/lib/AST/ParseJavadoc.cpp b/src/lib/AST/ParseJavadoc.cpp index b8bd81857a..1886abaf7b 100644 --- a/src/lib/AST/ParseJavadoc.cpp +++ b/src/lib/AST/ParseJavadoc.cpp @@ -1260,7 +1260,10 @@ visitBlockCommandComment( visitChildren(C->getParagraph()); // Here, we want empty briefs, because // the @brief command was explicitly given. - jd_.brief.emplace(std::move(brief)); + if (!brief.children.empty()) + { + jd_.brief.emplace(std::move(brief)); + } return; } diff --git a/src/lib/Gen/adoc/AdocGenerator.cpp b/src/lib/Gen/adoc/AdocGenerator.cpp index 58d837d39a..cdd7717a96 100644 --- a/src/lib/Gen/adoc/AdocGenerator.cpp +++ b/src/lib/Gen/adoc/AdocGenerator.cpp @@ -11,22 +11,11 @@ #include "AdocGenerator.hpp" #include "AdocEscape.hpp" -#include "DocVisitor.hpp" #include namespace clang::mrdocs { namespace adoc { -std::string -AdocGenerator:: -toString(hbs::HandlebarsCorpus const& c, doc::Node const& I) const -{ - std::string s; - DocVisitor visitor(c, s); - doc::visit(I, visitor); - return s; -} - void AdocGenerator:: escape(OutputRef& os, std::string_view const str) const diff --git a/src/lib/Gen/adoc/AdocGenerator.hpp b/src/lib/Gen/adoc/AdocGenerator.hpp index c4bd42818a..a604be9ca3 100644 --- a/src/lib/Gen/adoc/AdocGenerator.hpp +++ b/src/lib/Gen/adoc/AdocGenerator.hpp @@ -17,11 +17,9 @@ #include #include -namespace clang { -namespace mrdocs { -namespace adoc { +namespace clang::mrdocs::adoc { -class AdocGenerator +class AdocGenerator final : public hbs::HandlebarsGenerator { public: @@ -44,17 +42,10 @@ class AdocGenerator return "Asciidoc"; } - std::string - toString( - hbs::HandlebarsCorpus const&, - doc::Node const&) const override; - void escape(OutputRef& os, std::string_view str) const override; }; -} // adoc -} // mrdocs -} // clang +} // clang::mrdocs::adoc #endif diff --git a/src/lib/Gen/adoc/DocVisitor.cpp b/src/lib/Gen/adoc/DocVisitor.cpp deleted file mode 100644 index fe26541942..0000000000 --- a/src/lib/Gen/adoc/DocVisitor.cpp +++ /dev/null @@ -1,349 +0,0 @@ -// -// Licensed under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) -// Copyright (c) 2023 Krystian Stasiowski (sdkrystian@gmail.com) -// Copyright (c) 2024 Alan de Freitas (alandefreitas@gmail.com) -// -// Official repository: https://github.com/cppalliance/mrdocs -// - -#include "DocVisitor.hpp" -#include "lib/Gen/adoc/AdocEscape.hpp" -#include "lib/Support/Radix.hpp" -#include -#include -#include -#include -#include -#include - -namespace clang::mrdocs::adoc { - -void -DocVisitor:: -operator()( - doc::Admonition const& I) const -{ - std::string_view label; - switch(I.admonish) - { - case doc::Admonish::note: - label = "NOTE"; - break; - case doc::Admonish::tip: - label = "TIP"; - break; - case doc::Admonish::important: - label = "IMPORTANT"; - break; - case doc::Admonish::caution: - label = "CAUTION"; - break; - case doc::Admonish::warning: - label = "WARNING"; - break; - default: - MRDOCS_UNREACHABLE(); - } - fmt::format_to(std::back_inserter(dest_), "[{}]\n", label); - (*this)(static_cast(I)); -} - -void -DocVisitor:: -operator()( - doc::Code const& I) const -{ - auto const leftMargin = measureLeftMargin(I.children); - dest_ += - "[,cpp]\n" - "----\n"; - for(auto const& it : RangeFor(I.children)) - { - doc::visit(*it.value, - [&](T const& text) - { - if constexpr(std::derived_from) - { - if(! text.string.empty()) - { - std::string_view s = text.string; - s.remove_prefix(leftMargin); - dest_.append(s); - } - dest_.push_back('\n'); - } - else - { - MRDOCS_UNREACHABLE(); - } - }); - } - dest_ += "----\n"; -} - -void -DocVisitor:: -operator()( - doc::Heading const& I) const -{ - fmt::format_to(ins_, "\n=== {}\n\n", AdocEscape(I.string)); -} - -void -DocVisitor:: -operator()( - doc::Paragraph const& I) const -{ - operator()(I.children); - dest_.push_back('\n'); - dest_.push_back('\n'); -} - -void -DocVisitor:: -operator()(std::vector> children) const -{ - if (children.empty()) - { - return; - } - - std::size_t i = 0; - for (auto it = children.begin(); it != children.end(); ++it) - { - auto& child = *it; - if (i != 0 && - i != children.size() - 1) - { - write(*child, *this); - } - else - { - auto childCopy = *it; - if (i == 0) - { - childCopy->string = ltrim(childCopy->string); - } - if (i == children.size() - 1) - { - childCopy->string = rtrim(childCopy->string); - } - write(*childCopy, *this); - } - i = i + 1; - } -} - -void -DocVisitor:: -operator()( - doc::Brief const& I) const -{ - std::span const children = I.children; - if (children.empty()) - { - return; - } - - std::size_t i = 0; - for (auto it = children.begin(); it != children.end(); ++it) - { - auto& child = *it; - if (i != 0 && - i != children.size() - 1) - { - write(*child, *this); - } - else - { - auto childCopy = *it; - if (i == 0) - { - childCopy->string = ltrim(childCopy->string); - } - if (i == children.size() - 1) - { - childCopy->string = rtrim(childCopy->string); - } - write(*childCopy, *this); - } - i = i + 1; - } -} - -void -DocVisitor:: -operator()( - doc::Link const& I) const -{ - dest_.append("link:"); - dest_.append(I.href); - dest_.push_back('['); - dest_.append(AdocEscape(I.string)); - dest_.push_back(']'); -} - -void -DocVisitor:: -operator()( - doc::ListItem const& I) const -{ - std::span children = I.children; - if (children.empty()) - { - return; - } - dest_.append("* "); - bool non_empty = write(*children.front(), *this); - for(auto const& child : children.subspan(1)) - { - if (non_empty) - { - dest_.push_back('\n'); - } - non_empty = write(*child, *this); - } - dest_.push_back('\n'); -} - -void -DocVisitor:: -operator()( - doc::UnorderedList const& I) const -{ - if (I.items.empty()) - { - return; - } - for(auto const& child : I.items) - { - operator()(child); - } - dest_.push_back('\n'); -} - -void -DocVisitor:: -operator()(doc::Param const& I) const -{ - (*this)(I.children); -} - -void -DocVisitor:: -operator()(doc::Returns const& I) const -{ - (*this)(I.children); -} - -void -DocVisitor:: -operator()(doc::Text const& I) const -{ - if (I.string.empty()) - { - dest_.append("\n\n"); - } else - { - dest_.append(AdocEscape(I.string)); - } -} - -void -DocVisitor:: -operator()(doc::Styled const& I) const -{ - switch(I.style) - { - case doc::Style::none: - dest_.append(AdocEscape(I.string)); - break; - case doc::Style::bold: - fmt::format_to(std::back_inserter(dest_), "*{}*", AdocEscape(I.string)); - break; - case doc::Style::mono: - fmt::format_to(std::back_inserter(dest_), "`{}`", AdocEscape(I.string)); - break; - case doc::Style::italic: - fmt::format_to(std::back_inserter(dest_), "_{}_", AdocEscape(I.string)); - break; - default: - MRDOCS_UNREACHABLE(); - } -} - -void -DocVisitor:: -operator()(doc::TParam const& I) const -{ - (*this)(I.children); -} - -void -DocVisitor:: -operator()(doc::Reference const& I) const -{ - if (I.Kind == doc::NodeKind::related) - return; - - if (I.id == SymbolID::invalid) - { - return (*this)(static_cast(I)); - } - dom::Object symbolObj = corpus_.construct(corpus_->get(I.id)); - if (symbolObj.exists("url")) - { - std::string url = symbolObj.get("url").getString().str(); - if (url.starts_with('/')) - { - url.erase(0, 1); - } - fmt::format_to( - std::back_inserter(dest_), - "xref:{}[{}]", - url, AdocEscape(I.string)); - return; - } - fmt::format_to( - std::back_inserter(dest_), - "`{}`", - AdocEscape(I.string)); -} - -void -DocVisitor:: -operator()(doc::Throws const& I) const -{ - (*this)(I.children); -} - -std::size_t -DocVisitor:: -measureLeftMargin(std::vector> const& list) -{ - if(list.empty()) - { - return 0; - } - auto n = static_cast(-1); - for(auto& text : list) - { - if (trim(text->string).empty()) - { - continue; - } - auto const space = - text->string.size() - ltrim(text->string).size(); - if (n > space) - { - n = space; - } - } - return n; -} - -} // clang::mrdocs::adoc diff --git a/src/lib/Gen/adoc/DocVisitor.hpp b/src/lib/Gen/adoc/DocVisitor.hpp deleted file mode 100644 index 7afbc703f7..0000000000 --- a/src/lib/Gen/adoc/DocVisitor.hpp +++ /dev/null @@ -1,103 +0,0 @@ -// -// Licensed under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) -// Copyright (c) 2024 Alan de Freitas (alandefreitas@gmail.com) -// -// Official repository: https://github.com/cppalliance/mrdocs -// - -#ifndef MRDOCS_LIB_GEN_ADOC_DOCVISITOR_HPP -#define MRDOCS_LIB_GEN_ADOC_DOCVISITOR_HPP - -#include -#include "lib/Gen/hbs/HandlebarsCorpus.hpp" -#include - -namespace clang::mrdocs::adoc { - -class DocVisitor -{ - hbs::HandlebarsCorpus const& corpus_; - std::string& dest_; - std::back_insert_iterator ins_; - - template - bool - write( - doc::Node const& node, - Fn&& fn) const - { - const auto n_before = dest_.size(); - doc::visit(node, std::forward(fn)); - return dest_.size() != n_before; - } - -public: - DocVisitor( - hbs::HandlebarsCorpus const& corpus, - std::string& dest) noexcept - : corpus_(corpus) - , dest_(dest) - , ins_(std::back_inserter(dest_)) - { - } - - void - operator()(doc::Admonition const& I) const; - - void - operator()(doc::Code const& I) const; - - void - operator()(doc::Heading const& I) const; - - void - operator()(doc::Paragraph const& I) const; - - void - operator()(std::vector> children) const; - - void - operator()(doc::Brief const& I) const; - - void - operator()(doc::Link const& I) const; - - void - operator()(doc::ListItem const& I) const; - - void - operator()(doc::UnorderedList const& I) const; - - void - operator()(doc::Param const& I) const; - - void - operator()(doc::Returns const& I) const; - - void - operator()(doc::Text const& I) const; - - void - operator()(doc::Styled const& I) const; - - void - operator()(doc::TParam const& I) const; - - void - operator()(doc::Reference const& I) const; - - void - operator()(doc::Throws const& I) const; - - static - std::size_t - measureLeftMargin(std::vector> const& list); -}; - -} // clang::mrdocs::adoc - -#endif diff --git a/src/lib/Gen/hbs/HandlebarsCorpus.cpp b/src/lib/Gen/hbs/HandlebarsCorpus.cpp index 331a58c68a..d83722b0f1 100644 --- a/src/lib/Gen/hbs/HandlebarsCorpus.cpp +++ b/src/lib/Gen/hbs/HandlebarsCorpus.cpp @@ -22,116 +22,6 @@ namespace clang::mrdocs::hbs { -namespace { - -dom::Value -domCreate( - doc::Param const& I, - HandlebarsCorpus const& corpus) -{ - dom::Object::storage_type entries = { - { "name", I.name } - }; - if (std::string s = corpus.toStringFn(corpus, I); !s.empty()) - { - entries.emplace_back( - "description", std::move(s)); - } - // Direction - if (I.direction == doc::ParamDirection::in) - { - entries.emplace_back( - "direction", "in"); - } - else if (I.direction == doc::ParamDirection::out) - { - entries.emplace_back( - "direction", "out"); - } - else if (I.direction == doc::ParamDirection::inout) - { - entries.emplace_back( - "direction", "inout"); - } - return dom::Object(std::move(entries)); -} - -dom::Value -domCreate( - doc::TParam const& I, - HandlebarsCorpus const& corpus) -{ - dom::Object::storage_type entries = { - { "name", I.name } - }; - std::string s = corpus.toStringFn(corpus, I); - if (!s.empty()) - { - entries.emplace_back( - "description", std::move(s)); - } - return dom::Object(std::move(entries)); -} - -dom::Value -domCreate( - doc::Throws const& I, - HandlebarsCorpus const& corpus) -{ - dom::Object::storage_type entries = { - { "exception", I.exception.string } - }; - std::string s = corpus.toStringFn(corpus, I); - if (!s.empty()) - { - entries.emplace_back( - "description", std::move(s)); - } - return dom::Object(std::move(entries)); -} - -dom::Value -domCreate( - doc::See const& I, - HandlebarsCorpus const& corpus) -{ - return corpus.toStringFn(corpus, I); -} - -dom::Value -domCreate( - SymbolID const& I, - HandlebarsCorpus const& corpus) -{ - return corpus.get(I); -} - -dom::Value -domCreate( - doc::Precondition const& I, - HandlebarsCorpus const& corpus) -{ - return corpus.toStringFn(corpus, I); -} - -dom::Value -domCreate( - doc::Postcondition const& I, - HandlebarsCorpus const& corpus) -{ - return corpus.toStringFn(corpus, I); -} - -dom::Value -domCreate( - doc::Returns const& I, - HandlebarsCorpus const& corpus) -{ - return corpus.toStringFn(corpus, I); -} - -} // (anon) - dom::Object HandlebarsCorpus:: construct(Info const& I) const @@ -173,102 +63,4 @@ getURL(Info const& I) const return href; } -dom::Value -HandlebarsCorpus:: -getJavadoc(Javadoc const& jd) const -{ - dom::Object::storage_type objKeyValues; - objKeyValues.reserve(2); - - /* Emplace the string value representing the - Javadoc node. - - When the string is empty, the object key - is undefined. - */ - auto emplaceString = [&]( - std::string_view key, - T const& I) - { - std::string s; - if constexpr (std::derived_from) - { - s += toStringFn(*this, I); - } - else if constexpr (std::ranges::range) - { - using value_type = std::ranges::range_value_t; - if constexpr (IsPolymorphic_v) - { - for (value_type const& v: I) - { - auto const& node = dynamic_cast(*v); - s += toStringFn(*this, node); - } - } - else - { - for (doc::Node const* t: I) - { - s += toStringFn(*this, *t); - } - } - } - if(! s.empty()) - { - objKeyValues.emplace_back(key, std::move(s)); - } - }; - - /* Emplace an array of objects where each element - represents the properties of the node type, - such as "name" and "description". - */ - auto emplaceObjectArray = [&]( - std::string_view key, - Range const& nodes) - { - using value_type = std::ranges::range_value_t; - dom::Array::storage_type elements; - elements.reserve(nodes.size()); - for (value_type const& elem : nodes) - { - if constexpr (requires { *elem; }) - { - if (!elem) - { - continue; - } - elements.emplace_back(domCreate(*elem, *this)); - } - else - { - elements.emplace_back(domCreate(elem, *this)); - } - } - if (elements.empty()) - { - return; - } - objKeyValues.emplace_back(key, dom::newArray< - dom::DefaultArrayImpl>(std::move(elements))); - }; - - // brief - if (jd.brief) - { - emplaceString("brief", *jd.brief); - } - emplaceString("description", jd.blocks); - emplaceObjectArray("returns", jd.returns); - emplaceObjectArray("params", jd.params); - emplaceObjectArray("tparams", jd.tparams); - emplaceObjectArray("exceptions", jd.exceptions); - emplaceObjectArray("see", jd.sees); - emplaceObjectArray("related", jd.related); - emplaceObjectArray("preconditions", jd.preconditions); - emplaceObjectArray("postconditions", jd.postconditions); - return dom::Object(std::move(objKeyValues)); -} - } // clang::mrdocs::hbs diff --git a/src/lib/Gen/hbs/HandlebarsCorpus.hpp b/src/lib/Gen/hbs/HandlebarsCorpus.hpp index 3623811e87..3567d9590b 100644 --- a/src/lib/Gen/hbs/HandlebarsCorpus.hpp +++ b/src/lib/Gen/hbs/HandlebarsCorpus.hpp @@ -36,9 +36,6 @@ class HandlebarsCorpus final : public DomCorpus /** File extension for the markup files. */ std::string fileExtension; - /** Function to convert a Javadoc node to a string. */ - std::function toStringFn; - /** Constructor. Initializes the HandlebarsCorpus with the given corpus and options. @@ -49,12 +46,10 @@ class HandlebarsCorpus final : public DomCorpus */ HandlebarsCorpus( Corpus const& corpus, - std::string_view fileExtension, - std::function toStringFn) + std::string_view fileExtension) : DomCorpus(corpus) , names_(corpus, corpus.config->legibleNames) , fileExtension(fileExtension) - , toStringFn(std::move(toStringFn)) { } @@ -73,14 +68,6 @@ class HandlebarsCorpus final : public DomCorpus */ std::string getURL(Info const& I) const; - - /** Return a Dom value representing the Javadoc. - - @param jd The Javadoc object to get the Javadoc for. - @return A dom::Value representing the Javadoc. - */ - dom::Value - getJavadoc(Javadoc const& jd) const override; }; } // clang::mrdocs::hbs diff --git a/src/lib/Gen/hbs/HandlebarsGenerator.cpp b/src/lib/Gen/hbs/HandlebarsGenerator.cpp index e74f2cf38a..97e3c47cfc 100644 --- a/src/lib/Gen/hbs/HandlebarsGenerator.cpp +++ b/src/lib/Gen/hbs/HandlebarsGenerator.cpp @@ -68,10 +68,7 @@ createDomCorpus( Corpus const& corpus) { return { corpus, - gen.fileExtension(), - [&gen](HandlebarsCorpus const& c, doc::Node const& n) { - return gen.toString(c, n); - }}; + gen.fileExtension()}; } } // (anon) diff --git a/src/lib/Gen/hbs/HandlebarsGenerator.hpp b/src/lib/Gen/hbs/HandlebarsGenerator.hpp index 175c73bba0..3248517c62 100644 --- a/src/lib/Gen/hbs/HandlebarsGenerator.hpp +++ b/src/lib/Gen/hbs/HandlebarsGenerator.hpp @@ -18,8 +18,7 @@ #include #include -namespace clang { -namespace mrdocs { +namespace clang::mrdocs { class OutputRef; @@ -53,15 +52,6 @@ class HandlebarsGenerator std::string_view fileName, Corpus const& corpus) const; - /** Convert a Javadoc node to a string. - */ - virtual - std::string - toString(HandlebarsCorpus const&, doc::Node const&) const - { - return {}; - } - /** Output an escaped string to the output stream. */ virtual @@ -70,7 +60,7 @@ class HandlebarsGenerator }; } // hbs -} // mrdocs -} // clang + +} // clang::mrdocs #endif diff --git a/src/lib/Gen/html/DocVisitor.cpp b/src/lib/Gen/html/DocVisitor.cpp deleted file mode 100644 index 4233a3bec2..0000000000 --- a/src/lib/Gen/html/DocVisitor.cpp +++ /dev/null @@ -1,351 +0,0 @@ -// -// Licensed under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) -// Copyright (c) 2023 Krystian Stasiowski (sdkrystian@gmail.com) -// Copyright (c) 2024 Alan de Freitas (alandefreitas@gmail.com) -// -// Official repository: https://github.com/cppalliance/mrdocs -// - -#include "DocVisitor.hpp" -#include "lib/Support/Radix.hpp" -#include "mrdocs/Support/Handlebars.hpp" -#include -#include -#include -#include -#include - -namespace clang { -namespace mrdocs { -namespace html { - -void -DocVisitor:: -operator()( - doc::Admonition const& I) const -{ - std::string_view label; - switch(I.admonish) - { - case doc::Admonish::note: - label = "NOTE"; - break; - case doc::Admonish::tip: - label = "TIP"; - break; - case doc::Admonish::important: - label = "IMPORTANT"; - break; - case doc::Admonish::caution: - label = "CAUTION"; - break; - case doc::Admonish::warning: - label = "WARNING"; - break; - default: - MRDOCS_UNREACHABLE(); - } - fmt::format_to(std::back_inserter(dest_), - "
\n

{}

\n", label); - (*this)(static_cast(I)); - dest_.append("
\n"); -} - -void -DocVisitor:: -operator()( - doc::Code const& I) const -{ - auto const leftMargin = measureLeftMargin(I.children); - dest_.append("\n"); - for(auto const& it : RangeFor(I.children)) - { - doc::visit(*it.value, - [&](T const& text) - { - if constexpr(std::is_same_v) - { - if(! text.string.empty()) - { - std::string_view s = text.string; - s.remove_prefix(leftMargin); - dest_.append(s); - } - dest_.push_back('\n'); - } - else - { - MRDOCS_UNREACHABLE(); - } - }); - } - dest_.append("\n"); -} - -void -DocVisitor:: -operator()( - doc::Heading const& I) const -{ - fmt::format_to(ins_, "

{}

\n", I.string); -} - -// Also handles doc::Brief -void -DocVisitor:: -operator()( - doc::Paragraph const& I) const -{ - if (I.children.empty()) - { - return; - } - - dest_.append("

"); - std::size_t i = 0; - for (auto it = I.children.begin(); it != I.children.end(); ++it) - { - auto& child = *it; - auto childCopy = child; - if (i == 0) - { - childCopy->string = ltrim(childCopy->string); - } - else if (auto prevIt = std::prev(it); - !(*prevIt)->string.empty() && !childCopy->string.empty()) - { - char const pc = (*(prevIt))->string.back(); - char const cc = childCopy->string.front(); - if (!std::isspace(pc) && !std::isspace(cc)) - { - dest_.push_back(' '); - } - } - if (i == I.children.size() - 1) - { - childCopy->string = rtrim(childCopy->string); - } - write(*childCopy, *this); - i = i + 1; - } - dest_.append("

\n"); -} - -void -DocVisitor:: -operator()( - doc::Brief const& I) const -{ - if (I.children.empty()) - { - return; - } - - dest_.append(""); - std::size_t i = 0; - for (auto it = I.children.begin(); it != I.children.end(); ++it) - { - auto& child = *it; - auto childCopy = child; - if (i == 0) - { - childCopy->string = ltrim(childCopy->string); - } - else if (auto prevIt = std::prev(it); - !(*prevIt)->string.empty() && !childCopy->string.empty()) - { - char const pc = (*(prevIt))->string.back(); - char const cc = childCopy->string.front(); - if (!std::isspace(pc) && !std::isspace(cc)) - { - dest_.push_back(' '); - } - } - if (i == I.children.size() - 1) - { - childCopy->string = rtrim(childCopy->string); - } - write(*childCopy, *this); - i = i + 1; - } - dest_.append("\n"); -} - -void -DocVisitor:: -operator()( - doc::Link const& I) const -{ - dest_.append(""); - dest_.append(I.string); - dest_.append(""); -} - -void -DocVisitor:: -operator()( - doc::ListItem const& I) const -{ - dest_.append("
  • "); - for(auto const& it : RangeFor(I.children)) - { - auto const n = dest_.size(); - doc::visit(*it.value, *this); - // detect empty text blocks - if(! it.last && dest_.size() > n) - { - // wrap past 80 cols - if (dest_.size() < 80) - { - dest_.push_back(' '); - } else - { - dest_.append("\n"); - } - } - } - dest_.append("
    • \n"); -} - -void -DocVisitor:: -operator()( - doc::UnorderedList const& I) const -{ - if (I.items.empty()) - { - return; - } - dest_.append("
      \n"); - for(auto const& child : I.items) - { - operator()(child); - } - dest_.append("
    \n"); -} - -void -DocVisitor:: -operator()(doc::Param const& I) const -{ - this->operator()(static_cast(I)); -} - -void -DocVisitor:: -operator()(doc::Returns const& I) const -{ - (*this)(static_cast(I)); -} - -void -DocVisitor:: -operator()(doc::Text const& I) const -{ - fmt::format_to(std::back_inserter(dest_), "{}", HTMLEscape(I.string)); -} - -void -DocVisitor:: -operator()(doc::Styled const& I) const -{ - switch(I.style) - { - case doc::Style::none: - dest_.append(I.string); - break; - case doc::Style::bold: - fmt::format_to(std::back_inserter(dest_), "{}", HTMLEscape(I.string)); - break; - case doc::Style::mono: - fmt::format_to(std::back_inserter(dest_), "{}", HTMLEscape(I.string)); - break; - case doc::Style::italic: - fmt::format_to(std::back_inserter(dest_), "{}", HTMLEscape(I.string)); - break; - default: - MRDOCS_UNREACHABLE(); - } -} - -void -DocVisitor:: -operator()(doc::TParam const& I) const -{ - this->operator()(static_cast(I)); -} - -void -DocVisitor:: -operator()(doc::Reference const& I) const -{ - if (I.Kind == doc::NodeKind::related) - return; - - if (I.id == SymbolID::invalid) - { - return (*this)(static_cast(I)); - } - dom::Object symbolObj = corpus_.construct(corpus_->get(I.id)); - if (symbolObj.exists("url")) - { - std::string url = symbolObj.get("url").getString().str(); - if (url.starts_with('/')) - { - url.erase(0, 1); - } - // AFREITAS: Unlike Adoc, we need relative URLs for HTML - fmt::format_to( - std::back_inserter(dest_), - "{}", - url, HTMLEscape(I.string)); - return; - } - fmt::format_to( - std::back_inserter(dest_), - "{}", - HTMLEscape(I.string)); -} - -void -DocVisitor:: -operator()(doc::Throws const& I) const -{ - this->operator()(static_cast(I)); -} - -std::size_t -DocVisitor:: -measureLeftMargin( - std::vector> const& list) -{ - if(list.empty()) - { - return 0; - } - auto n = static_cast(-1); - for(auto& text : list) - { - if (trim(text->string).empty()) - { - continue; - } - auto const space = - text->string.size() - ltrim(text->string).size(); - if (n > space) - { - n = space; - } - } - return n; -} - -} // html -} // mrdocs -} // clang diff --git a/src/lib/Gen/html/DocVisitor.hpp b/src/lib/Gen/html/DocVisitor.hpp deleted file mode 100644 index 06f969be9e..0000000000 --- a/src/lib/Gen/html/DocVisitor.hpp +++ /dev/null @@ -1,100 +0,0 @@ -// -// Licensed under the Apache License v2.0 with LLVM Exceptions. -// See https://llvm.org/LICENSE.txt for license information. -// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -// -// Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) -// Copyright (c) 2024 Alan de Freitas (alandefreitas@gmail.com) -// -// Official repository: https://github.com/cppalliance/mrdocs -// - -#ifndef MRDOCS_LIB_GEN_HTML_DOCVISITOR_HPP -#define MRDOCS_LIB_GEN_HTML_DOCVISITOR_HPP - -#include -#include "lib/Gen/hbs/HandlebarsCorpus.hpp" -#include - -namespace clang::mrdocs::html { - -class DocVisitor -{ - hbs::HandlebarsCorpus const& corpus_; - std::string& dest_; - std::back_insert_iterator ins_; - - template - bool - write( - doc::Node const& node, - Fn&& fn) const - { - const auto n_before = dest_.size(); - doc::visit(node, std::forward(fn)); - return dest_.size() != n_before; - } - -public: - DocVisitor( - hbs::HandlebarsCorpus const& corpus, - std::string& dest) noexcept - : corpus_(corpus) - , dest_(dest) - , ins_(std::back_inserter(dest_)) - { - } - - void - operator()(doc::Admonition const& I) const; - - void - operator()(doc::Code const& I) const; - - void - operator()(doc::Heading const& I) const; - - void - operator()(doc::Paragraph const& I) const; - - void - operator()(doc::Brief const& I) const; - - void - operator()(doc::Link const& I) const; - - void - operator()(doc::ListItem const& I) const; - - void - operator()(doc::UnorderedList const& I) const; - - void - operator()(doc::Param const& I) const; - - void - operator()(doc::Returns const& I) const; - - void - operator()(doc::Text const& I) const; - - void - operator()(doc::Styled const& I) const; - - void - operator()(doc::TParam const& I) const; - - void - operator()(doc::Reference const& I) const; - - void - operator()(doc::Throws const& I) const; - - static - std::size_t - measureLeftMargin(std::vector> const& list); -}; - -} // clang::mrdocs::html - -#endif diff --git a/src/lib/Gen/html/HTMLGenerator.cpp b/src/lib/Gen/html/HTMLGenerator.cpp index 5341ebadc9..1368cf3c57 100644 --- a/src/lib/Gen/html/HTMLGenerator.cpp +++ b/src/lib/Gen/html/HTMLGenerator.cpp @@ -10,23 +10,11 @@ // #include "HTMLGenerator.hpp" -#include "DocVisitor.hpp" #include -namespace clang { -namespace mrdocs { +namespace clang::mrdocs { namespace html { -std::string -HTMLGenerator:: -toString(hbs::HandlebarsCorpus const& c, doc::Node const& I) const -{ - std::string s; - DocVisitor visitor(c, s); - doc::visit(I, visitor); - return s; -} - void HTMLGenerator:: escape(OutputRef& os, std::string_view str) const @@ -44,5 +32,4 @@ makeHTMLGenerator() return std::make_unique(); } -} // mrdocs -} // clang +} // clang::mrdocs diff --git a/src/lib/Gen/html/HTMLGenerator.hpp b/src/lib/Gen/html/HTMLGenerator.hpp index 0492b6992a..0b66f532bd 100644 --- a/src/lib/Gen/html/HTMLGenerator.hpp +++ b/src/lib/Gen/html/HTMLGenerator.hpp @@ -17,11 +17,9 @@ #include #include -namespace clang { -namespace mrdocs { -namespace html { +namespace clang::mrdocs::html { -class HTMLGenerator +class HTMLGenerator final : public hbs::HandlebarsGenerator { public: @@ -43,17 +41,10 @@ class HTMLGenerator return "HTML"; } - std::string - toString( - hbs::HandlebarsCorpus const&, - doc::Node const&) const override; - void escape(OutputRef& os, std::string_view str) const override; }; -} // html -} // mrdocs -} // clang +} // clang::mrdocs::html #endif diff --git a/src/lib/Lib/Config.cpp b/src/lib/Lib/Config.cpp index b48f3f91a8..d141ec2888 100644 --- a/src/lib/Lib/Config.cpp +++ b/src/lib/Lib/Config.cpp @@ -11,14 +11,13 @@ #include #include -#include -#include #include #include #include +#include +#include -namespace clang { -namespace mrdocs { +namespace clang::mrdocs { Config:: Config() noexcept @@ -566,5 +565,4 @@ outputDir() const return files::getParentDir(output); } -} // mrdocs -} // clang +} // clang::mrdocs diff --git a/src/lib/Metadata/Finalizers/JavadocFinalizer.cpp b/src/lib/Metadata/Finalizers/JavadocFinalizer.cpp index aca181b59e..f7389a2dc0 100644 --- a/src/lib/Metadata/Finalizers/JavadocFinalizer.cpp +++ b/src/lib/Metadata/Finalizers/JavadocFinalizer.cpp @@ -11,6 +11,7 @@ #include "JavadocFinalizer.hpp" #include +#include namespace clang::mrdocs { @@ -36,6 +37,20 @@ operator()(InfoTy& I) ScopeExitRestore s(current_context_, &I); + // Finalize references in javadoc + finalize(I.javadoc); + + finalizeInfoData(I); +} + +#define INFO(T) template void JavadocFinalizer::operator()(T## Info&); +#include + +template +void +JavadocFinalizer:: +finalizeInfoData(InfoTy& I) +{ #ifndef NDEBUG // Check references if (I.Parent) @@ -48,9 +63,6 @@ operator()(InfoTy& I) } #endif - // Finalize references in javadoc - finalize(I.javadoc); - if constexpr (requires { I.UsingDirectives; }) { finalize(I.UsingDirectives); @@ -113,7 +125,7 @@ operator()(InfoTy& I) } } -#define INFO(T) template void JavadocFinalizer::operator()(T## Info&); +#define INFO(T) template void JavadocFinalizer::finalizeInfoData(T## Info&); #include void @@ -195,6 +207,9 @@ finalize(Javadoc& javadoc) finalize(javadoc.postconditions); copyBriefAndDetails(javadoc); setAutoBrief(javadoc); + removeTempTextNodes(javadoc); + trimBlocks(javadoc); + unindentCodeBlocks(javadoc); } void @@ -515,14 +530,270 @@ setAutoBrief(Javadoc& javadoc) it = javadoc.blocks.erase(it); return; } + ++it; + } +} + +void +JavadocFinalizer:: +trimBlocks(Javadoc& javadoc) +{ + trimBlocks(javadoc.blocks); + if (javadoc.brief) + { + trimBlock(*javadoc.brief); + } + trimBlocks(javadoc.returns); + trimBlocks(javadoc.params); + trimBlocks(javadoc.tparams); + trimBlocks(javadoc.exceptions); + trimBlocks(javadoc.sees); + trimBlocks(javadoc.preconditions); + trimBlocks(javadoc.postconditions); +} + +void +JavadocFinalizer:: +trimBlocks(std::vector>& blocks) +{ + for (auto& block: blocks) + { + bool const isVerbatim = block->Kind == doc::NodeKind::code; + MRDOCS_CHECK_OR_CONTINUE(!isVerbatim); + trimBlock(*block); + } +} + +void +JavadocFinalizer:: +trimBlock(doc::Block& block) +{ + if (block.Kind == doc::NodeKind::unordered_list) + { + auto& ul = dynamic_cast(block); + trimBlocks(ul.items); + return; + } + + MRDOCS_CHECK_OR(!block.children.empty()); + + // Helper functions + static constexpr std::string_view whitespace_chars = " \t\n\v\f\r"; + auto endsWithSpace = [](std::string_view const str) { + return endsWithOneOf(str, whitespace_chars); + }; + auto startsWithSpace = [](std::string_view const str) { + return startsWithOneOf(str, whitespace_chars); + }; + + // The first children are ltrimmed as one + while (!block.children.empty()) + { + auto& first = block.children.front()->string; + if (startsWithSpace(first)) + { + first = ltrim(first); + } + if (first.empty()) + { + // "pop_front" + block.children.erase(block.children.begin()); + } else { - ++it; - continue; + break; + } + } + + // The last children are rtrimmed as one + while (!block.children.empty()) + { + auto& last = block.children.back()->string; + if (endsWithSpace(last)) + { + last = rtrim(last); + } + if (last.empty()) + { + block.children.pop_back(); + } + else + { + break; + } + } + + // Like in HTML, multiple whitespaces (spaces, tabs, and newlines) + // between and within child nodes are collapsed into a single space. + for ( + auto it = block.children.begin() + 1; + it != block.children.end(); + ++it) + { + auto& child = *it; + auto& prev = *std::prev(it); + if (endsWithSpace(prev->string) && startsWithSpace(child->string)) + { + // The first visible space character is maintained. + // All others are removed. + prev->string = rtrim(prev->string); + prev->string.push_back(' '); + child->string = ltrim(child->string); + } + } + + // Like in HTML, multiple whitespaces (spaces, tabs, and newlines) + // within child nodes are collapsed into a single space. + for (auto& child: block.children) + { + auto& str = child->string; + for (std::size_t i = 0; i < str.size();) + { + if (contains(whitespace_chars, str[i])) + { + std::size_t const runStart = i; + std::size_t runEnd = i + 1; + while ( + runEnd < str.size() && + contains(whitespace_chars, str[runEnd])) + { + ++runEnd; + } + if (runEnd > runStart + 1) + { + std::size_t const runSize = runEnd - runStart; + str.erase(runStart + 1, runSize - 1); + str[runStart] = ' '; + } + i = runEnd; + } + else + { + ++i; + } } } } +void +JavadocFinalizer:: +removeTempTextNodes(Javadoc& javadoc) +{ + removeTempTextNodes(javadoc.blocks); + if (javadoc.brief) + { + removeTempTextNodes(*javadoc.brief); + } + removeTempTextNodes(javadoc.returns); + removeTempTextNodes(javadoc.params); + removeTempTextNodes(javadoc.tparams); + removeTempTextNodes(javadoc.exceptions); + removeTempTextNodes(javadoc.sees); + removeTempTextNodes(javadoc.preconditions); + removeTempTextNodes(javadoc.postconditions); +} + +void +JavadocFinalizer:: +removeTempTextNodes(std::vector>& blocks) +{ + for (auto& block: blocks) + { + removeTempTextNodes(*block); + } + // Erase all blocks of zero elements + std::erase_if(blocks, [](Polymorphic const& block) { + if (block->Kind == doc::NodeKind::unordered_list) + { + return get(block).items.empty(); + } + if (block->Kind == doc::NodeKind::heading) + { + return get(block).string.empty(); + } + return block->children.empty(); + }); +} + +void +JavadocFinalizer:: +removeTempTextNodes(doc::Block& block) +{ + std::erase_if(block.children, [](Polymorphic const& child) { + return is_one_of( + child->Kind, + { doc::NodeKind::copied, doc::NodeKind::related }); + }); +} + +void +JavadocFinalizer:: +unindentCodeBlocks(Javadoc& javadoc) +{ + unindentCodeBlocks(javadoc.blocks); + if (javadoc.brief) + { + unindentCodeBlocks(*javadoc.brief); + } + unindentCodeBlocks(javadoc.returns); + unindentCodeBlocks(javadoc.params); + unindentCodeBlocks(javadoc.tparams); + unindentCodeBlocks(javadoc.exceptions); + unindentCodeBlocks(javadoc.sees); + unindentCodeBlocks(javadoc.preconditions); + unindentCodeBlocks(javadoc.postconditions); +} + +void +JavadocFinalizer:: +unindentCodeBlocks(std::vector>& blocks) +{ + for (auto& block: blocks) + { + if (block->Kind == doc::NodeKind::code) + { + unindentCodeBlocks(*block); + } + } +} + +void +JavadocFinalizer:: +unindentCodeBlocks(doc::Block& block) +{ + MRDOCS_CHECK_OR(block.Kind == doc::NodeKind::code); + MRDOCS_CHECK_OR(!block.children.empty()); + + // Determine the left margin + std::size_t leftMargin = std::numeric_limits::max(); + for (auto& pText: block.children) + { + auto& text = dynamic_cast(*pText); + if (text.string.empty()) + { + continue; + } + std::size_t const margin = text.string.find_first_not_of(" \t"); + if (margin == std::string::npos) + { + continue; + } + leftMargin = std::min(leftMargin, margin); + } + + MRDOCS_CHECK_OR(leftMargin != std::numeric_limits::max()); + + // Remove the left margin + for (auto& pText: block.children) + { + auto& text = dynamic_cast(*pText); + if (text.string.size() < leftMargin) + { + continue; + } + text.string = text.string.substr(leftMargin); + } +} void JavadocFinalizer:: diff --git a/src/lib/Metadata/Finalizers/JavadocFinalizer.hpp b/src/lib/Metadata/Finalizers/JavadocFinalizer.hpp index 9356f52ba0..4efa46a390 100644 --- a/src/lib/Metadata/Finalizers/JavadocFinalizer.hpp +++ b/src/lib/Metadata/Finalizers/JavadocFinalizer.hpp @@ -106,6 +106,11 @@ class JavadocFinalizer void operator()(InfoTy& I); + // Check and finalize data unrelated to javadoc + template + void + finalizeInfoData(InfoTy& I); + private: // Look for symbol and set the id of a reference void @@ -127,6 +132,83 @@ class JavadocFinalizer void setAutoBrief(Javadoc& javadoc); + /* Trim all block childen in the javadoc + + The first child is rtrimmed and the last child is ltrimmed. + + Like in HTML, multiple whitespaces (spaces, tabs, and newlines) + between and within child nodes are collapsed into a single space. + */ + void + trimBlocks(Javadoc& javadoc); + + // A range of values derived from blocks + template + requires std::derived_from, doc::Block> + void + trimBlocks(R&& blocks) + { + for (auto& block: blocks) + { + trimBlock(block); + } + } + + void + trimBlocks(std::vector>& blocks); + + void + trimBlock(doc::Block& block); + + /* Remove all temporary text nodes from a block + + The temporary nodes (copied, related, etc...) should + have been processed by the previous steps and should + not be present in the final output. + */ + void + removeTempTextNodes(Javadoc& javadoc); + + // A range of values derived from blocks + template + requires std::derived_from, doc::Block> + void + removeTempTextNodes(R&& blocks) + { + for (auto& block: blocks) + { + removeTempTextNodes(block); + } + } + + void + removeTempTextNodes(std::vector>& blocks); + + void + removeTempTextNodes(doc::Block& block); + + /* Unindent all code blocks in the javadoc + */ + void + unindentCodeBlocks(Javadoc& javadoc); + + template + requires std::derived_from, doc::Block> + void + unindentCodeBlocks(R&& blocks) + { + for (auto& block: blocks) + { + trimBlock(block); + } + } + + void + unindentCodeBlocks(std::vector>& blocks); + + void + unindentCodeBlocks(doc::Block& block); + // Set id to invalid if it does not exist void finalize(SymbolID& id); diff --git a/src/lib/Metadata/Javadoc.cpp b/src/lib/Metadata/Javadoc.cpp index 5f4db623c2..c1639e4436 100644 --- a/src/lib/Metadata/Javadoc.cpp +++ b/src/lib/Metadata/Javadoc.cpp @@ -20,9 +20,134 @@ namespace clang { namespace mrdocs { - namespace doc { +dom::String +toString(NodeKind kind) noexcept +{ + switch(kind) + { + case NodeKind::text: + return "text"; + case NodeKind::admonition: + return "admonition"; + case NodeKind::brief: + return "brief"; + case NodeKind::code: + return "code"; + case NodeKind::heading: + return "heading"; + case NodeKind::link: + return "link"; + case NodeKind::list_item: + return "list_item"; + case NodeKind::unordered_list: + return "unordered_list"; + case NodeKind::paragraph: + return "paragraph"; + case NodeKind::param: + return "param"; + case NodeKind::returns: + return "returns"; + case NodeKind::styled: + return "styled"; + case NodeKind::tparam: + return "tparam"; + case NodeKind::reference: + return "reference"; + case NodeKind::copied: + return "copied"; + case NodeKind::throws: + return "throws"; + case NodeKind::details: + return "details"; + case NodeKind::see: + return "see"; + case NodeKind::related: + return "related"; + case NodeKind::precondition: + return "precondition"; + case NodeKind::postcondition: + return "postcondition"; + default: + MRDOCS_UNREACHABLE(); + } +} + +dom::String +toString(Style kind) noexcept +{ + switch(kind) + { + case Style::none: + return ""; + case Style::mono: + return "mono"; + case Style::bold: + return "bold"; + case Style::italic: + return "italic"; + default: + MRDOCS_UNREACHABLE(); + } +} + +dom::String +toString(Admonish kind) noexcept +{ + switch(kind) + { + case Admonish::none: + return ""; + case Admonish::note: + return "note"; + case Admonish::tip: + return "tip"; + case Admonish::important: + return "important"; + case Admonish::caution: + return "caution"; + case Admonish::warning: + return "warning"; + default: + MRDOCS_UNREACHABLE(); + } +} + +dom::String +toString(ParamDirection kind) noexcept +{ + switch(kind) + { + case ParamDirection::none: + return ""; + case ParamDirection::in: + return "in"; + case ParamDirection::out: + return "out"; + case ParamDirection::inout: + return "inout"; + default: + MRDOCS_UNREACHABLE(); + } +} + +dom::String +toString(Parts kind) noexcept +{ + switch(kind) + { + case Parts::all: + return "all"; + case Parts::brief: + return "brief"; + case Parts::description: + return "description"; + default: + MRDOCS_UNREACHABLE(); + } +} + Text& Block:: emplace_back( @@ -54,24 +179,6 @@ append(std::vector> const& otherChildren) otherChildren.end()); } -dom::String -toString( - doc::Style style) noexcept -{ - switch(style) - { - case doc::Style::bold: return "bold"; - case doc::Style::mono: return "mono"; - case doc::Style::italic: return "italic"; - - // should never get here - case doc::Style::none: return ""; - - default: - // unknown style - MRDOCS_UNREACHABLE(); - } -} std::strong_ordering operator<=>(Polymorphic const& lhs, Polymorphic const& rhs) @@ -365,17 +472,5 @@ append(std::vector>&& blocks) } } -/** Return the Javadoc as a @ref dom::Value. - */ -void -tag_invoke( - dom::ValueFromTag, - dom::Value& v, - Javadoc const& doc, - DomCorpus const* domCorpus) -{ - v = domCorpus->getJavadoc(doc); -} - } // mrdocs } // clang diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.adoc b/test-files/golden-tests/config/auto-brief/auto-brief.adoc index f89bb9e497..d3b1075a81 100644 --- a/test-files/golden-tests/config/auto-brief/auto-brief.adoc +++ b/test-files/golden-tests/config/auto-brief/auto-brief.adoc @@ -25,10 +25,10 @@ | This function has documentation but no brief. | <> -| Details will be copied copyDetailsFromExplicitBrief +| Details will be copied | <> -| Custom brief docNoBriefFunction +| Custom brief | <> | This will not be copied. @@ -37,7 +37,7 @@ | This is more documentation. | <> -| Custom brief noDocFunction +| Custom brief | <> | This is the explicit brief. @@ -175,18 +175,11 @@ void copyBriefFromFirstValid(); ---- -=== Description - - -explicitBriefFunction - - - [#copyDetailsFromCopyBrief] == copyDetailsFromCopyBrief -Details will be copied copyDetailsFromExplicitBrief +Details will be copied === Synopsis @@ -203,7 +196,7 @@ copyDetailsFromCopyBrief(); == copyDetailsFromDocNoBrief -Custom brief docNoBriefFunction +Custom brief === Synopsis @@ -254,7 +247,7 @@ copyDetailsFromFirstSentenceAsBrief(); == copyDetailsFromNoDoc -Custom brief noDocFunction +Custom brief === Synopsis diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.html b/test-files/golden-tests/config/auto-brief/auto-brief.html index 87c9d75e6e..60fa55622c 100644 --- a/test-files/golden-tests/config/auto-brief/auto-brief.html +++ b/test-files/golden-tests/config/auto-brief/auto-brief.html @@ -19,88 +19,67 @@

    Functions

    -copyBriefFromCopyBrief This is the explicit brief. - +copyBriefFromCopyBrief This is the explicit brief. -copyBriefFromExplicitBrief This is the explicit brief. - +copyBriefFromExplicitBrief This is the explicit brief. -copyBriefFromFirstSentenceAsBrief This is the brief. - +copyBriefFromFirstSentenceAsBrief This is the brief. -copyBriefFromFirstValid This function has documentation but no brief. - +copyBriefFromFirstValid This function has documentation but no brief. -copyDetailsFromCopyBrief Details will be copied copyDetailsFromExplicitBrief - +copyDetailsFromCopyBrief Details will be copied -copyDetailsFromDocNoBrief Custom brief docNoBriefFunction - +copyDetailsFromDocNoBrief Custom brief -copyDetailsFromExplicitBrief This will not be copied. - +copyDetailsFromExplicitBrief This will not be copied. -copyDetailsFromFirstSentenceAsBrief This is more documentation. - +copyDetailsFromFirstSentenceAsBrief This is more documentation. -copyDetailsFromNoDoc Custom brief noDocFunction - +copyDetailsFromNoDoc Custom brief -copyDocFromCopyBrief This is the explicit brief. - +copyDocFromCopyBrief This is the explicit brief. -copyDocFromExplicitBrief This is the explicit brief. - +copyDocFromExplicitBrief This is the explicit brief. -copyDocFromFirstSentenceAsBrief This is the brief. - +copyDocFromFirstSentenceAsBrief This is the brief. -docNoBriefFunction This function has documentation but no brief. - +docNoBriefFunction This function has documentation but no brief. -explicitBriefFunction This is the explicit brief. - +explicitBriefFunction This is the explicit brief. -explicitBriefFunction2 This is the explicit brief. - +explicitBriefFunction2 This is the explicit brief. -failCircularReferenceCopyFunction +failCircularReferenceCopyFunction -failCircularSourceFunctionA +failCircularSourceFunctionA -failCircularSourceFunctionB +failCircularSourceFunctionB -failCopyBriefFromDocNoBrief This function has documentation but no brief. - +failCopyBriefFromDocNoBrief This function has documentation but no brief. -failCopyBriefFromInvalidReference +failCopyBriefFromInvalidReference -failCopyBriefFromNoDoc +failCopyBriefFromNoDoc -failCopyDetailsFromInvalidReference +failCopyDetailsFromInvalidReference -failCopyDocFromDocNoBrief This function has documentation but no brief. - +failCopyDocFromDocNoBrief This function has documentation but no brief. -failCopyDocFromInvalidReference +failCopyDocFromInvalidReference -failCopyDocFromNoDoc +failCopyDocFromNoDoc -failInvalidReferenceCopyFunctions +failInvalidReferenceCopyFunctions -firstSentenceAsBriefFunction This is the brief. - +firstSentenceAsBriefFunction This is the brief. -noDocFunction +noDocFunction -recursiveReferenceCopyFunction Final recursive brief - +recursiveReferenceCopyFunction Final recursive brief -recursiveSourceFunctionA Final recursive brief - +recursiveSourceFunctionA Final recursive brief -recursiveSourceFunctionB Final recursive brief - +recursiveSourceFunctionB Final recursive brief @@ -109,8 +88,7 @@

    Functions

    copyBriefFromCopyBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -130,8 +108,7 @@

    Synopsis

    copyBriefFromExplicitBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -151,8 +128,7 @@

    Synopsis

    copyBriefFromFirstSentenceAsBrief

    -This is the brief. - +This is the brief.
    @@ -172,8 +148,7 @@

    Synopsis

    copyBriefFromFirstValid

    -This function has documentation but no brief. - +This function has documentation but no brief.
    @@ -187,20 +162,13 @@

    Synopsis

    copyBriefFromFirstValid(); - -
    -

    Description

    -

    explicitBriefFunction

    - -

    copyDetailsFromCopyBrief

    -Details will be copied copyDetailsFromExplicitBrief - +Details will be copied
    @@ -220,8 +188,7 @@

    Synopsis

    copyDetailsFromDocNoBrief

    -Custom brief docNoBriefFunction - +Custom brief
    @@ -241,8 +208,7 @@

    Synopsis

    copyDetailsFromExplicitBrief

    -This will not be copied. - +This will not be copied.
    @@ -262,8 +228,7 @@

    Synopsis

    copyDetailsFromFirstSentenceAsBrief

    -This is more documentation. - +This is more documentation.
    @@ -283,8 +248,7 @@

    Synopsis

    copyDetailsFromNoDoc

    -Custom brief noDocFunction - +Custom brief
    @@ -304,8 +268,7 @@

    Synopsis

    copyDocFromCopyBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -322,17 +285,14 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    copyDocFromExplicitBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -349,17 +309,14 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    copyDocFromFirstSentenceAsBrief

    -This is the brief. - +This is the brief.
    @@ -376,17 +333,14 @@

    Synopsis

    Description

    -

    This is more documentation.

    - - +

    This is more documentation.

    docNoBriefFunction

    -This function has documentation but no brief. - +This function has documentation but no brief.
    @@ -406,8 +360,7 @@

    Synopsis

    explicitBriefFunction

    -This is the explicit brief. - +This is the explicit brief.
    @@ -424,17 +377,14 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    explicitBriefFunction2

    -This is the explicit brief. - +This is the explicit brief.
    @@ -451,9 +401,7 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    @@ -508,8 +456,7 @@

    Synopsis

    failCopyBriefFromDocNoBrief

    -This function has documentation but no brief. - +This function has documentation but no brief.
    @@ -577,8 +524,7 @@

    Synopsis

    failCopyDocFromDocNoBrief

    -This function has documentation but no brief. - +This function has documentation but no brief.
    @@ -646,8 +592,7 @@

    Synopsis

    firstSentenceAsBriefFunction

    -This is the brief. - +This is the brief.
    @@ -664,9 +609,7 @@

    Synopsis

    Description

    -

    This is more documentation.

    - - +

    This is more documentation.

    @@ -689,8 +632,7 @@

    Synopsis

    recursiveReferenceCopyFunction

    -Final recursive brief - +Final recursive brief
    @@ -710,8 +652,7 @@

    Synopsis

    recursiveSourceFunctionA

    -Final recursive brief - +Final recursive brief
    @@ -731,8 +672,7 @@

    Synopsis

    recursiveSourceFunctionB

    -Final recursive brief - +Final recursive brief
    diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.xml b/test-files/golden-tests/config/auto-brief/auto-brief.xml index 12cc95c781..1eabb762cb 100644 --- a/test-files/golden-tests/config/auto-brief/auto-brief.xml +++ b/test-files/golden-tests/config/auto-brief/auto-brief.xml @@ -32,18 +32,13 @@ This function has documentation but no brief. - - explicitBriefFunction - - Details will be copied - copyDetailsFromExplicitBrief - + Details will be copied @@ -51,9 +46,7 @@ - Custom brief - docNoBriefFunction - + Custom brief @@ -77,9 +70,7 @@ - Custom brief - noDocFunction - + Custom brief diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc b/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc index 42ca7a0d40..353c71d11a 100644 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc +++ b/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc @@ -25,10 +25,10 @@ | | <> -| Details will be copied copyDetailsFromExplicitBrief +| Details will be copied | <> -| Custom brief docNoBriefFunction +| Custom brief | <> | @@ -37,7 +37,7 @@ | | <> -| Custom brief noDocFunction +| Custom brief | <> | This is the explicit brief. @@ -171,18 +171,11 @@ void copyBriefFromFirstValid(); ---- -=== Description - - -explicitBriefFunction - - - [#copyDetailsFromCopyBrief] == copyDetailsFromCopyBrief -Details will be copied copyDetailsFromExplicitBrief +Details will be copied === Synopsis @@ -199,7 +192,7 @@ copyDetailsFromCopyBrief(); == copyDetailsFromDocNoBrief -Custom brief docNoBriefFunction +Custom brief === Synopsis @@ -262,7 +255,7 @@ This is more documentation. == copyDetailsFromNoDoc -Custom brief noDocFunction +Custom brief === Synopsis diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.html b/test-files/golden-tests/config/auto-brief/no-auto-brief.html index cd517bbfd8..afc305a179 100644 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.html +++ b/test-files/golden-tests/config/auto-brief/no-auto-brief.html @@ -19,79 +19,67 @@

    Functions

    -copyBriefFromCopyBrief This is the explicit brief. - +copyBriefFromCopyBrief This is the explicit brief. -copyBriefFromExplicitBrief This is the explicit brief. - +copyBriefFromExplicitBrief This is the explicit brief. -copyBriefFromFirstSentenceAsBrief +copyBriefFromFirstSentenceAsBrief -copyBriefFromFirstValid +copyBriefFromFirstValid -copyDetailsFromCopyBrief Details will be copied copyDetailsFromExplicitBrief - +copyDetailsFromCopyBrief Details will be copied -copyDetailsFromDocNoBrief Custom brief docNoBriefFunction - +copyDetailsFromDocNoBrief Custom brief -copyDetailsFromExplicitBrief +copyDetailsFromExplicitBrief -copyDetailsFromFirstSentenceAsBrief +copyDetailsFromFirstSentenceAsBrief -copyDetailsFromNoDoc Custom brief noDocFunction - +copyDetailsFromNoDoc Custom brief -copyDocFromCopyBrief This is the explicit brief. - +copyDocFromCopyBrief This is the explicit brief. -copyDocFromExplicitBrief This is the explicit brief. - +copyDocFromExplicitBrief This is the explicit brief. -copyDocFromFirstSentenceAsBrief +copyDocFromFirstSentenceAsBrief -docNoBriefFunction +docNoBriefFunction -explicitBriefFunction This is the explicit brief. - +explicitBriefFunction This is the explicit brief. -explicitBriefFunction2 This is the explicit brief. - +explicitBriefFunction2 This is the explicit brief. -failCircularReferenceCopyFunction +failCircularReferenceCopyFunction -failCircularSourceFunctionA +failCircularSourceFunctionA -failCircularSourceFunctionB +failCircularSourceFunctionB -failCopyBriefFromDocNoBrief +failCopyBriefFromDocNoBrief -failCopyBriefFromInvalidReference +failCopyBriefFromInvalidReference -failCopyBriefFromNoDoc +failCopyBriefFromNoDoc -failCopyDetailsFromInvalidReference +failCopyDetailsFromInvalidReference -failCopyDocFromDocNoBrief +failCopyDocFromDocNoBrief -failCopyDocFromInvalidReference +failCopyDocFromInvalidReference -failCopyDocFromNoDoc +failCopyDocFromNoDoc -failInvalidReferenceCopyFunctions +failInvalidReferenceCopyFunctions -firstSentenceAsBriefFunction +firstSentenceAsBriefFunction -noDocFunction +noDocFunction -recursiveReferenceCopyFunction Final recursive brief - +recursiveReferenceCopyFunction Final recursive brief -recursiveSourceFunctionA Final recursive brief - +recursiveSourceFunctionA Final recursive brief -recursiveSourceFunctionB Final recursive brief - +recursiveSourceFunctionB Final recursive brief @@ -100,8 +88,7 @@

    Functions

    copyBriefFromCopyBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -121,8 +108,7 @@

    Synopsis

    copyBriefFromExplicitBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -168,20 +154,13 @@

    Synopsis

    copyBriefFromFirstValid(); -
    -
    -

    Description

    -

    explicitBriefFunction

    - -

    copyDetailsFromCopyBrief

    -Details will be copied copyDetailsFromExplicitBrief - +Details will be copied
    @@ -201,8 +180,7 @@

    Synopsis

    copyDetailsFromDocNoBrief

    -Custom brief docNoBriefFunction - +Custom brief
    @@ -235,9 +213,7 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    @@ -257,18 +233,15 @@

    Synopsis

    Description

    -

    This is the brief.

    -

    This is more documentation.

    - - +

    This is the brief.

    +

    This is more documentation.

    copyDetailsFromNoDoc

    -Custom brief noDocFunction - +Custom brief
    @@ -288,8 +261,7 @@

    Synopsis

    copyDocFromCopyBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -306,17 +278,14 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    copyDocFromExplicitBrief

    -This is the explicit brief. - +This is the explicit brief.
    @@ -333,9 +302,7 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    @@ -355,10 +322,8 @@

    Synopsis

    Description

    -

    This is the brief.

    -

    This is more documentation.

    - - +

    This is the brief.

    +

    This is more documentation.

    @@ -378,17 +343,14 @@

    Synopsis

    Description

    -

    This function has documentation but no brief.

    - - +

    This function has documentation but no brief.

    explicitBriefFunction

    -This is the explicit brief. - +This is the explicit brief.
    @@ -405,17 +367,14 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    explicitBriefFunction2

    -This is the explicit brief. - +This is the explicit brief.
    @@ -432,9 +391,7 @@

    Synopsis

    Description

    -

    This will not be copied.

    - - +

    This will not be copied.

    @@ -566,9 +523,7 @@

    Synopsis

    Description

    -

    This function has documentation but no brief.

    - - +

    This function has documentation but no brief.

    @@ -636,10 +591,8 @@

    Synopsis

    Description

    -

    This is the brief.

    -

    This is more documentation.

    - - +

    This is the brief.

    +

    This is more documentation.

    @@ -662,8 +615,7 @@

    Synopsis

    recursiveReferenceCopyFunction

    -Final recursive brief - +Final recursive brief
    @@ -683,8 +635,7 @@

    Synopsis

    recursiveSourceFunctionA

    -Final recursive brief - +Final recursive brief
    @@ -704,8 +655,7 @@

    Synopsis

    recursiveSourceFunctionB

    -Final recursive brief - +Final recursive brief
    diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.xml b/test-files/golden-tests/config/auto-brief/no-auto-brief.xml index e158d3663b..76486b0fb5 100644 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.xml +++ b/test-files/golden-tests/config/auto-brief/no-auto-brief.xml @@ -26,18 +26,13 @@ - - explicitBriefFunction - - Details will be copied - copyDetailsFromExplicitBrief - + Details will be copied @@ -45,9 +40,7 @@ - Custom brief - docNoBriefFunction - + Custom brief @@ -74,9 +67,7 @@ - Custom brief - noDocFunction - + Custom brief diff --git a/test-files/golden-tests/config/extract-all/no-extract-all.html b/test-files/golden-tests/config/extract-all/no-extract-all.html index 292ea2e7d5..9c7a2419a8 100644 --- a/test-files/golden-tests/config/extract-all/no-extract-all.html +++ b/test-files/golden-tests/config/extract-all/no-extract-all.html @@ -19,11 +19,9 @@

    Functions

    -docFunction Documented function - +docFunction Documented function -sometimesDocFunction Sometimes documented function - +sometimesDocFunction Sometimes documented function @@ -32,8 +30,7 @@

    Functions

    docFunction

    -Documented function - +Documented function
    @@ -53,8 +50,7 @@

    Synopsis

    sometimesDocFunction

    -Sometimes documented function - +Sometimes documented function
    diff --git a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html index 21efc67a24..5c446b3116 100644 --- a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html +++ b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html @@ -19,20 +19,15 @@

    Namespaces

    -documented_ns Namespace documentation - +documented_ns Namespace documentation -mixed_ns Should decay to see-below - +mixed_ns Should decay to see-below -mixed_regular_ns Should decay to regular - +mixed_regular_ns Should decay to regular -regular_ns Regular namespace - +regular_ns Regular namespace -see_below_ns Should decay to see-below - +see_below_ns Should decay to see-below @@ -46,11 +41,9 @@

    Namespace Aliases

    -empty_ns_alias Should still work - +empty_ns_alias Should still work -regular_ns_alias Should work - +regular_ns_alias Should work @@ -78,8 +71,7 @@

    Using Namespace Directives

    documented_ns

    -Namespace documentation - +Namespace documentation
    @@ -88,8 +80,7 @@

    documented_ns

    mixed_ns

    -Should decay to see-below - +Should decay to see-below
    @@ -128,8 +119,7 @@

    Synopsis

    mixed_regular_ns

    -Should decay to regular - +Should decay to regular
    @@ -187,8 +177,7 @@

    Synopsis

    regular_ns

    -Regular namespace - +Regular namespace
    @@ -227,8 +216,7 @@

    Synopsis

    see_below_ns

    -Should decay to see-below - +Should decay to see-below
    @@ -286,8 +274,7 @@

    Synopsis

    empty_ns_alias

    -Should still work - +Should still work
    @@ -306,8 +293,7 @@

    Synopsis

    regular_ns_alias

    -Should work - +Should work
    diff --git a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html index a1cdd90e12..01408ca36b 100644 --- a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html +++ b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html @@ -19,16 +19,15 @@

    Types

    -base +base -base_base +base_base -derived +derived -private_derived +private_derived -protected_derived Should inherit functions as protected. - +protected_derived Should inherit functions as protected. @@ -58,20 +57,15 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -86,14 +80,11 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. @@ -103,8 +94,7 @@

    Protected Member Functions

    base::base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -124,8 +114,7 @@

    Synopsis

    base::base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -145,8 +134,7 @@

    Synopsis

    base::derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -166,8 +154,7 @@

    Synopsis

    base::do_base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -187,8 +174,7 @@

    Synopsis

    base::do_base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -208,8 +194,7 @@

    Synopsis

    base::do_derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -249,11 +234,9 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -264,8 +247,7 @@

    Member Functions

    base_base::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -285,8 +267,7 @@

    Synopsis

    base_base::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -328,26 +309,19 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. -excluded_inherited This function should be inherited by derived classes. - +excluded_inherited This function should be inherited by derived classes. @@ -362,20 +336,15 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. -do_excluded_inherited This function should be inherited by derived classes. - +do_excluded_inherited This function should be inherited by derived classes. -do_shadowed This function should be shadowed by derived classes. - +do_shadowed This function should be shadowed by derived classes. @@ -385,8 +354,7 @@

    Protected Member Functions

    derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -406,8 +374,7 @@

    Synopsis

    derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -427,8 +394,7 @@

    Synopsis

    derived::excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -448,8 +414,7 @@

    Synopsis

    derived::do_excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -469,8 +434,7 @@

    Synopsis

    derived::do_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -512,11 +476,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -527,8 +489,7 @@

    Member Functions

    private_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -548,8 +509,7 @@

    Synopsis

    private_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -569,8 +529,7 @@

    Synopsis

    protected_derived

    -Should inherit functions as protected. - +Should inherit functions as protected.
    @@ -596,11 +555,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -615,38 +572,27 @@

    Protected Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. -do_excluded_inherited This function should be inherited by derived classes. - +do_excluded_inherited This function should be inherited by derived classes. -do_shadowed This function should be shadowed by derived classes. - +do_shadowed This function should be shadowed by derived classes. -excluded_inherited This function should be inherited by derived classes. - +excluded_inherited This function should be inherited by derived classes. @@ -656,8 +602,7 @@

    Protected Member Functions

    protected_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -677,8 +622,7 @@

    Synopsis

    protected_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -698,8 +642,7 @@

    Synopsis

    protected_derived::do_excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -719,8 +662,7 @@

    Synopsis

    protected_derived::do_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -740,8 +682,7 @@

    Synopsis

    protected_derived::excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    diff --git a/test-files/golden-tests/config/inherit-base-members/copy.html b/test-files/golden-tests/config/inherit-base-members/copy.html index f1ab624604..2b44629172 100644 --- a/test-files/golden-tests/config/inherit-base-members/copy.html +++ b/test-files/golden-tests/config/inherit-base-members/copy.html @@ -19,16 +19,15 @@

    Types

    -base +base -base_base +base_base -derived +derived -private_derived +private_derived -protected_derived Should inherit functions as protected. - +protected_derived Should inherit functions as protected. @@ -58,20 +57,15 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -86,14 +80,11 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. @@ -103,8 +94,7 @@

    Protected Member Functions

    base::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -124,8 +114,7 @@

    Synopsis

    base::base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -145,8 +134,7 @@

    Synopsis

    base::base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -166,8 +154,7 @@

    Synopsis

    base::derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -187,8 +174,7 @@

    Synopsis

    base::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -208,8 +194,7 @@

    Synopsis

    base::do_base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -229,8 +214,7 @@

    Synopsis

    base::do_base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -250,8 +234,7 @@

    Synopsis

    base::do_derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -291,11 +274,9 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -306,8 +287,7 @@

    Member Functions

    base_base::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -327,8 +307,7 @@

    Synopsis

    base_base::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -370,26 +349,19 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. -excluded_inherited This function should be inherited by derived classes. - +excluded_inherited This function should be inherited by derived classes. @@ -404,20 +376,15 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. -do_excluded_inherited This function should be inherited by derived classes. - +do_excluded_inherited This function should be inherited by derived classes. -do_shadowed This function should be shadowed by derived classes. - +do_shadowed This function should be shadowed by derived classes. @@ -427,8 +394,7 @@

    Protected Member Functions

    derived::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -448,8 +414,7 @@

    Synopsis

    derived::base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -469,8 +434,7 @@

    Synopsis

    derived::base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -490,8 +454,7 @@

    Synopsis

    derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -511,8 +474,7 @@

    Synopsis

    derived::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -532,8 +494,7 @@

    Synopsis

    derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -553,8 +514,7 @@

    Synopsis

    derived::excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -574,8 +534,7 @@

    Synopsis

    derived::do_base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -595,8 +554,7 @@

    Synopsis

    derived::do_base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -616,8 +574,7 @@

    Synopsis

    derived::do_derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -637,8 +594,7 @@

    Synopsis

    derived::do_excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -658,8 +614,7 @@

    Synopsis

    derived::do_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -701,11 +656,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -716,8 +669,7 @@

    Member Functions

    private_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -737,8 +689,7 @@

    Synopsis

    private_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -758,8 +709,7 @@

    Synopsis

    protected_derived

    -Should inherit functions as protected. - +Should inherit functions as protected.
    @@ -785,11 +735,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -804,38 +752,27 @@

    Protected Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. -do_excluded_inherited This function should be inherited by derived classes. - +do_excluded_inherited This function should be inherited by derived classes. -do_shadowed This function should be shadowed by derived classes. - +do_shadowed This function should be shadowed by derived classes. -excluded_inherited This function should be inherited by derived classes. - +excluded_inherited This function should be inherited by derived classes. @@ -845,8 +782,7 @@

    Protected Member Functions

    protected_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -866,8 +802,7 @@

    Synopsis

    protected_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -887,8 +822,7 @@

    Synopsis

    protected_derived::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -908,8 +842,7 @@

    Synopsis

    protected_derived::base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -929,8 +862,7 @@

    Synopsis

    protected_derived::base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -950,8 +882,7 @@

    Synopsis

    protected_derived::derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -971,8 +902,7 @@

    Synopsis

    protected_derived::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -992,8 +922,7 @@

    Synopsis

    protected_derived::do_base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -1013,8 +942,7 @@

    Synopsis

    protected_derived::do_base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -1034,8 +962,7 @@

    Synopsis

    protected_derived::do_derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -1055,8 +982,7 @@

    Synopsis

    protected_derived::do_excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -1076,8 +1002,7 @@

    Synopsis

    protected_derived::do_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -1097,8 +1022,7 @@

    Synopsis

    protected_derived::excluded_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    diff --git a/test-files/golden-tests/config/inherit-base-members/never.html b/test-files/golden-tests/config/inherit-base-members/never.html index a71731578e..9f15748f28 100644 --- a/test-files/golden-tests/config/inherit-base-members/never.html +++ b/test-files/golden-tests/config/inherit-base-members/never.html @@ -19,16 +19,15 @@

    Types

    -base +base -base_base +base_base -derived +derived -private_derived +private_derived -protected_derived Should inherit functions as protected. - +protected_derived Should inherit functions as protected. @@ -58,14 +57,11 @@

    Member Functions

    -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. @@ -80,14 +76,11 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. @@ -97,8 +90,7 @@

    Protected Member Functions

    base::base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -118,8 +110,7 @@

    Synopsis

    base::base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -139,8 +130,7 @@

    Synopsis

    base::derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -160,8 +150,7 @@

    Synopsis

    base::do_base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -181,8 +170,7 @@

    Synopsis

    base::do_base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -202,8 +190,7 @@

    Synopsis

    base::do_derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -243,11 +230,9 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -258,8 +243,7 @@

    Member Functions

    base_base::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -279,8 +263,7 @@

    Synopsis

    base_base::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -322,11 +305,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -337,8 +318,7 @@

    Member Functions

    derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -358,8 +338,7 @@

    Synopsis

    derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -401,11 +380,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -416,8 +393,7 @@

    Member Functions

    private_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -437,8 +413,7 @@

    Synopsis

    private_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -458,8 +433,7 @@

    Synopsis

    protected_derived

    -Should inherit functions as protected. - +Should inherit functions as protected.
    @@ -485,11 +459,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -500,8 +472,7 @@

    Member Functions

    protected_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -521,8 +492,7 @@

    Synopsis

    protected_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    diff --git a/test-files/golden-tests/config/inherit-base-members/reference.html b/test-files/golden-tests/config/inherit-base-members/reference.html index 746bdd49bd..acca0279cc 100644 --- a/test-files/golden-tests/config/inherit-base-members/reference.html +++ b/test-files/golden-tests/config/inherit-base-members/reference.html @@ -19,16 +19,15 @@

    Types

    -base +base -base_base +base_base -derived +derived -private_derived +private_derived -protected_derived Should inherit functions as protected. - +protected_derived Should inherit functions as protected. @@ -58,20 +57,15 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -86,14 +80,11 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. @@ -103,8 +94,7 @@

    Protected Member Functions

    base::base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -124,8 +114,7 @@

    Synopsis

    base::base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -145,8 +134,7 @@

    Synopsis

    base::derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -166,8 +154,7 @@

    Synopsis

    base::do_base_inherited

    -This function should be inherited by derived classes. - +This function should be inherited by derived classes.
    @@ -187,8 +174,7 @@

    Synopsis

    base::do_base_shadowed

    -This function should shadow the excluded_base function. - +This function should shadow the excluded_base function.
    @@ -208,8 +194,7 @@

    Synopsis

    base::do_derived_shadowed

    -This function should be shadowed by derived classes. - +This function should be shadowed by derived classes.
    @@ -249,11 +234,9 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. @@ -264,8 +247,7 @@

    Member Functions

    base_base::base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -285,8 +267,7 @@

    Synopsis

    base_base::do_base_base_inherited

    -This function should be indirectly inherited by derived classes. - +This function should be indirectly inherited by derived classes.
    @@ -328,23 +309,17 @@

    Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -359,14 +334,11 @@

    Protected Member Functions

    -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. @@ -376,8 +348,7 @@

    Protected Member Functions

    derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -397,8 +368,7 @@

    Synopsis

    derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -440,11 +410,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -455,8 +423,7 @@

    Member Functions

    private_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -476,8 +443,7 @@

    Synopsis

    private_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -497,8 +463,7 @@

    Synopsis

    protected_derived

    -Should inherit functions as protected. - +Should inherit functions as protected.
    @@ -524,11 +489,9 @@

    Member Functions

    -derived_shadowed This function should shadow the base class function. - +derived_shadowed This function should shadow the base class function. -do_derived_shadowed This function should shadow the base class function. - +do_derived_shadowed This function should shadow the base class function. @@ -543,29 +506,21 @@

    Protected Member Functions

    -base_base_inherited This function should be indirectly inherited by derived classes. - +base_base_inherited This function should be indirectly inherited by derived classes. -base_inherited This function should be inherited by derived classes. - +base_inherited This function should be inherited by derived classes. -base_shadowed This function should shadow the excluded_base function. - +base_shadowed This function should shadow the excluded_base function. -derived_shadowed This function should be shadowed by derived classes. - +derived_shadowed This function should be shadowed by derived classes. -do_base_base_inherited This function should be indirectly inherited by derived classes. - +do_base_base_inherited This function should be indirectly inherited by derived classes. -do_base_inherited This function should be inherited by derived classes. - +do_base_inherited This function should be inherited by derived classes. -do_base_shadowed This function should shadow the excluded_base function. - +do_base_shadowed This function should shadow the excluded_base function. -do_derived_shadowed This function should be shadowed by derived classes. - +do_derived_shadowed This function should be shadowed by derived classes. @@ -575,8 +530,7 @@

    Protected Member Functions

    protected_derived::derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    @@ -596,8 +550,7 @@

    Synopsis

    protected_derived::do_derived_shadowed

    -This function should shadow the base class function. - +This function should shadow the base class function.
    diff --git a/test-files/golden-tests/config/sort/sort-members.html b/test-files/golden-tests/config/sort/sort-members.html index 54f344ad2c..0b0bd82c57 100644 --- a/test-files/golden-tests/config/sort/sort-members.html +++ b/test-files/golden-tests/config/sort/sort-members.html @@ -48,17 +48,17 @@

    Functions

    -f +f -g +g -h +h -operator! +operator! -operator== +operator== -operator!= +operator!= @@ -233,21 +233,21 @@

    Member Functions

    -Z [constructor] +Z [constructor] -~Z [destructor] +~Z [destructor] -foo +foo -operator bool +operator bool -operator! +operator! -operator== +operator== -operator!= +operator!= -operator<=> +operator<=> diff --git a/test-files/golden-tests/config/sort/unordered.html b/test-files/golden-tests/config/sort/unordered.html index 6607955d77..8cadc129ba 100644 --- a/test-files/golden-tests/config/sort/unordered.html +++ b/test-files/golden-tests/config/sort/unordered.html @@ -48,17 +48,17 @@

    Functions

    -operator!= +operator!= -operator== +operator== -operator! +operator! -h +h -g +g -f +f @@ -233,21 +233,21 @@

    Member Functions

    -operator<=> +operator<=> -operator!= +operator!= -operator== +operator== -operator! +operator! -operator bool +operator bool -foo +foo -~Z [destructor] +~Z [destructor] -Z [constructor] +Z [constructor] diff --git a/test-files/golden-tests/core/libcxx.adoc b/test-files/golden-tests/core/libcxx.adoc index 84a9257a51..f2cba35296 100644 --- a/test-files/golden-tests/core/libcxx.adoc +++ b/test-files/golden-tests/core/libcxx.adoc @@ -39,7 +39,7 @@ requires std::is_integral_v<T>; === Description -This function calculates the square root of a given integral value using bit manipulation. +This function calculates the square root of a given integral value using bit manipulation. diff --git a/test-files/golden-tests/core/libcxx.html b/test-files/golden-tests/core/libcxx.html index 27207c9d08..c1f03db035 100644 --- a/test-files/golden-tests/core/libcxx.html +++ b/test-files/golden-tests/core/libcxx.html @@ -19,8 +19,7 @@

    Functions

    -sqrt Computes the square root of an integral value. - +sqrt Computes the square root of an integral value. @@ -29,8 +28,7 @@

    Functions

    sqrt

    -Computes the square root of an integral value. - +Computes the square root of an integral value.
    @@ -49,9 +47,7 @@

    Synopsis

    Description

    -

    This function calculates the square root of a given integral value using bit manipulation.

    - - +

    This function calculates the square root of a given integral value using bit manipulation.

    Exceptions

    @@ -65,16 +61,14 @@

    Exceptions

    std::invalid_argument -

    if the input value is negative.

    - +if the input value is negative.

    Return Value

    -

    The square root of the input value.

    - +The square root of the input value.

    Template Parameters

    @@ -88,8 +82,7 @@

    Template Parameters

    T -

    The type of the input value. Must be an integral type.

    - +The type of the input value. Must be an integral type. @@ -106,8 +99,7 @@

    Parameters

    value -

    The integral value to compute the square root of.

    - +The integral value to compute the square root of. diff --git a/test-files/golden-tests/core/libcxx.xml b/test-files/golden-tests/core/libcxx.xml index 64e6bccc8e..9c4e1e034d 100644 --- a/test-files/golden-tests/core/libcxx.xml +++ b/test-files/golden-tests/core/libcxx.xml @@ -17,16 +17,16 @@ Computes the square root of an integral value. - This function calculates the square root of a given integral value using bit manipulation. + This function calculates the square root of a given integral value using bit manipulation. The square root of the input value. - The integral value to compute the square root of. + The integral value to compute the square root of. - The type of the input value. Must be an integral type. + The type of the input value. Must be an integral type. if the input value is negative. diff --git a/test-files/golden-tests/filters/file/include-symlink.html b/test-files/golden-tests/filters/file/include-symlink.html index 757ff259ff..7c3c18ce8b 100644 --- a/test-files/golden-tests/filters/file/include-symlink.html +++ b/test-files/golden-tests/filters/file/include-symlink.html @@ -19,8 +19,7 @@

    Functions

    -f A brief. - +f A brief. @@ -29,8 +28,7 @@

    Functions

    f

    -A brief. - +A brief.
    diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.html b/test-files/golden-tests/filters/symbol-name/extraction-mode.html index 1f9b1d4a2c..e497643339 100644 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.html +++ b/test-files/golden-tests/filters/symbol-name/extraction-mode.html @@ -19,11 +19,9 @@

    Namespaces

    -regular_ns A regular namespace with different filters for members - +regular_ns A regular namespace with different filters for members -see_below_ns A see-below namespace - +see_below_ns A see-below namespace @@ -37,14 +35,11 @@

    Namespace Aliases

    -dependency_ns_alias Namespace alias to form the dependency on dependency_ns - +dependency_ns_alias Namespace alias to form the dependency on dependency_ns -implementation_defined_ns_alias Namespace alias to form a dependency on the implementation-defined namespace - +implementation_defined_ns_alias Namespace alias to form a dependency on the implementation-defined namespace -see_below_ns_alias Namespace alias to form a dependency on the see-below namespace - +see_below_ns_alias Namespace alias to form a dependency on the see-below namespace @@ -58,11 +53,9 @@

    Types

    -regular A regular symbol in the global namespace - +regular A regular symbol in the global namespace -see_below A see-below symbol in the global namespace - +see_below A see-below symbol in the global namespace @@ -76,17 +69,13 @@

    Functions

    -get_dependency A function to get a dependency symbol on the global namespace - +get_dependency A function to get a dependency symbol on the global namespace -get_implementation_defined A function to get an implementation-defined symbol in the global namespace - +get_implementation_defined A function to get an implementation-defined symbol in the global namespace -get_regular A function to get a regular symbol in the global namespace - +get_regular A function to get a regular symbol in the global namespace -get_see_below A function to get a see-below symbol in the global namespace - +get_see_below A function to get a see-below symbol in the global namespace @@ -95,8 +84,7 @@

    Functions

    regular_ns

    -A regular namespace with different filters for members - +A regular namespace with different filters for members
    @@ -110,11 +98,9 @@

    Types

    -regular A symbol that passes the filters - +regular A symbol that passes the filters -see_below A symbol that passes the see-below filter - +see_below A symbol that passes the see-below filter @@ -128,17 +114,13 @@

    Functions

    -get_dependency A function to get an excluded symbol - +get_dependency A function to get an excluded symbol -get_implementation_defined A function to get an implementation-defined symbol - +get_implementation_defined A function to get an implementation-defined symbol -get_regular A function to get a regular symbol - +get_regular A function to get a regular symbol -get_see_below A function to get a see-below symbol - +get_see_below A function to get a see-below symbol @@ -147,8 +129,7 @@

    Functions

    regular_ns::regular

    -A symbol that passes the filters - +A symbol that passes the filters
    @@ -172,8 +153,7 @@

    Types

    -also_regular Child of a regular symbol extracted as regular - +also_regular Child of a regular symbol extracted as regular @@ -181,17 +161,14 @@

    Types

    Description

    -

    The symbol should have a page as usual

    - - +

    The symbol should have a page as usual

    regular_ns::regular::also_regular

    -Child of a regular symbol extracted as regular - +Child of a regular symbol extracted as regular
    @@ -215,8 +192,7 @@

    Types

    -regular_as_well Grandchild of a regular symbol extracted as regular - +regular_as_well Grandchild of a regular symbol extracted as regular @@ -227,8 +203,7 @@

    Types

    regular_ns::regular::also_regular::regular_as_well

    -Grandchild of a regular symbol extracted as regular - +Grandchild of a regular symbol extracted as regular
    @@ -249,8 +224,7 @@

    Synopsis

    regular_ns::see_below

    -A symbol that passes the see-below filter - +A symbol that passes the see-below filter
    @@ -268,17 +242,14 @@

    Synopsis

    Description

    -

    A symbol that passes the filters and the see-below filter. The symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page.

    - - +

    A symbol that passes the filters and the see-below filter. The symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page.

    regular_ns::get_dependency

    -A function to get an excluded symbol - +A function to get an excluded symbol
    @@ -295,17 +266,14 @@

    Synopsis

    Description

    -

    When used in a function, only the symbol name should be shown. No links should be generated for this symbol.

    - - +

    When used in a function, only the symbol name should be shown. No links should be generated for this symbol.

    regular_ns::get_implementation_defined

    -A function to get an implementation-defined symbol - +A function to get an implementation-defined symbol
    @@ -322,18 +290,15 @@

    Synopsis

    Description

    -

    When used in a function, the implementation-defined comment should replace the real type.

    -

    It's the responsibility of the function documentation to explain the implementation-defined symbol.

    - - +

    When used in a function, the implementation-defined comment should replace the real type.

    +

    It's the responsibility of the function documentation to explain the implementation-defined symbol.

    regular_ns::get_regular

    -A function to get a regular symbol - +A function to get a regular symbol
    @@ -350,17 +315,14 @@

    Synopsis

    Description

    -

    When used in a function, the symbol should be shown as usual with a link to the page.

    - - +

    When used in a function, the symbol should be shown as usual with a link to the page.

    regular_ns::get_see_below

    -A function to get a see-below symbol - +A function to get a see-below symbol
    @@ -377,17 +339,14 @@

    Synopsis

    Description

    -

    When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere.

    - - +

    When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere.

    see_below_ns

    -A see-below namespace - +A see-below namespace
    @@ -401,11 +360,9 @@

    Types

    -regular Regular symbol in a see-below namespace - +regular Regular symbol in a see-below namespace -see_below See-below symbol in a see-below namespace - +see_below See-below symbol in a see-below namespace @@ -419,28 +376,23 @@

    Functions

    -get_dependency A function to get a dependency symbol in a see-below namespace - +get_dependency A function to get a dependency symbol in a see-below namespace -get_implementation_defined A function to get an implementation-defined symbol in a see-below namespace - +get_implementation_defined A function to get an implementation-defined symbol in a see-below namespace

    Description

    -

    All member symbols should become see-below. All members are traversed as see-below.

    -

    The documentation page for these symbols should include the see-below comment.

    - - +

    All member symbols should become see-below. All members are traversed as see-below.

    +

    The documentation page for these symbols should include the see-below comment.

    see_below_ns::regular

    -Regular symbol in a see-below namespace - +Regular symbol in a see-below namespace
    @@ -458,17 +410,14 @@

    Synopsis

    Description

    -

    The symbol becomes see-below because the whole namespace is see-below.

    - - +

    The symbol becomes see-below because the whole namespace is see-below.

    see_below_ns::see_below

    -See-below symbol in a see-below namespace - +See-below symbol in a see-below namespace
    @@ -486,17 +435,14 @@

    Synopsis

    Description

    -

    The symbol becomes see-below because the whole namespace is see-below and because it's explicitly marked as see-below.

    - - +

    The symbol becomes see-below because the whole namespace is see-below and because it's explicitly marked as see-below.

    see_below_ns::get_dependency

    -A function to get a dependency symbol in a see-below namespace - +A function to get a dependency symbol in a see-below namespace
    @@ -513,18 +459,15 @@

    Synopsis

    Description

    -

    The symbol should be extracted as a dependency because the exclude filter has precedence over the see-below filter. Only included symbols can be promoted to see-below.

    -

    It's the responsibility of the function documentation to explain the dependency.

    - - +

    The symbol should be extracted as a dependency because the exclude filter has precedence over the see-below filter. Only included symbols can be promoted to see-below.

    +

    It's the responsibility of the function documentation to explain the dependency.

    see_below_ns::get_implementation_defined

    -A function to get an implementation-defined symbol in a see-below namespace - +A function to get an implementation-defined symbol in a see-below namespace
    @@ -541,18 +484,15 @@

    Synopsis

    Description

    -

    When used in a function, the implementation-defined comment should replace the real type.

    -

    It's the responsibility of the function documentation to explain the implementation-defined symbol.

    - - +

    When used in a function, the implementation-defined comment should replace the real type.

    +

    It's the responsibility of the function documentation to explain the implementation-defined symbol.

    dependency_ns_alias

    -Namespace alias to form the dependency on dependency_ns - +Namespace alias to form the dependency on dependency_ns
    @@ -571,8 +511,7 @@

    Synopsis

    implementation_defined_ns_alias

    -Namespace alias to form a dependency on the implementation-defined namespace - +Namespace alias to form a dependency on the implementation-defined namespace
    @@ -591,8 +530,7 @@

    Synopsis

    see_below_ns_alias

    -Namespace alias to form a dependency on the see-below namespace - +Namespace alias to form a dependency on the see-below namespace
    @@ -608,17 +546,14 @@

    Synopsis

    Description

    -

    The alias should be linked as usual and, because it's a namespace, the members should be listed on the page.

    - - +

    The alias should be linked as usual and, because it's a namespace, the members should be listed on the page.

    regular

    -A regular symbol in the global namespace - +A regular symbol in the global namespace
    @@ -642,8 +577,7 @@

    Types

    -also_regular Child of a regular symbol: should be traversed as usual - +also_regular Child of a regular symbol: should be traversed as usual @@ -651,17 +585,14 @@

    Types

    Description

    -

    This symbol should have a page as usual.

    - - +

    This symbol should have a page as usual.

    regular::also_regular

    -Child of a regular symbol: should be traversed as usual - +Child of a regular symbol: should be traversed as usual
    @@ -685,8 +616,7 @@

    Types

    -regular_as_well Grandchild of a regular symbol: should be traversed as usual - +regular_as_well Grandchild of a regular symbol: should be traversed as usual @@ -697,8 +627,7 @@

    Types

    regular::also_regular::regular_as_well

    -Grandchild of a regular symbol: should be traversed as usual - +Grandchild of a regular symbol: should be traversed as usual
    @@ -719,8 +648,7 @@

    Synopsis

    see_below

    -A see-below symbol in the global namespace - +A see-below symbol in the global namespace
    @@ -738,18 +666,15 @@

    Synopsis

    Description

    -

    This symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page.

    -

    The synopsis should say "See below".

    - - +

    This symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page.

    +

    The synopsis should say "See below".

    get_dependency

    -A function to get a dependency symbol on the global namespace - +A function to get a dependency symbol on the global namespace
    @@ -766,17 +691,14 @@

    Synopsis

    Description

    -

    The symbol should be extracted as a dependency but its members should not be traversed.

    - - +

    The symbol should be extracted as a dependency but its members should not be traversed.

    get_implementation_defined

    -A function to get an implementation-defined symbol in the global namespace - +A function to get an implementation-defined symbol in the global namespace
    @@ -793,18 +715,15 @@

    Synopsis

    Description

    -

    When used in a function, the implementation-defined comment should replace the real type.

    -

    It's the responsibility of the function documentation to explain the implementation-defined symbol.

    - - +

    When used in a function, the implementation-defined comment should replace the real type.

    +

    It's the responsibility of the function documentation to explain the implementation-defined symbol.

    get_regular

    -A function to get a regular symbol in the global namespace - +A function to get a regular symbol in the global namespace
    @@ -821,17 +740,14 @@

    Synopsis

    Description

    -

    When used in a function, the symbol should be shown as usual with a link to the page.

    - - +

    When used in a function, the symbol should be shown as usual with a link to the page.

    get_see_below

    -A function to get a see-below symbol in the global namespace - +A function to get a see-below symbol in the global namespace
    @@ -848,9 +764,7 @@

    Synopsis

    Description

    -

    When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere.

    - - +

    When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere.

    diff --git a/test-files/golden-tests/filters/symbol-name/whitelist_0.html b/test-files/golden-tests/filters/symbol-name/whitelist_0.html index e826eb8ff0..1ea2254406 100644 --- a/test-files/golden-tests/filters/symbol-name/whitelist_0.html +++ b/test-files/golden-tests/filters/symbol-name/whitelist_0.html @@ -19,14 +19,11 @@

    Namespaces

    -N0 This namespace should extracted because it's implied by N0::f0_WL - +N0 This namespace should extracted because it's implied by N0::f0_WL -N1 This namespace should extracted because it's implied by N1::N3_WL and N1::N4::f1_WL - +N1 This namespace should extracted because it's implied by N1::N3_WL and N1::N4::f1_WL -N5 This namespace should extracted because it's implied by N5::N6::*7 - +N5 This namespace should extracted because it's implied by N5::N6::*7 @@ -40,8 +37,7 @@

    Types

    -C This namespace should be included because it strictly matches C - +C This namespace should be included because it strictly matches C @@ -50,8 +46,7 @@

    Types

    N0

    -This namespace should extracted because it's implied by N0::f0_WL - +This namespace should extracted because it's implied by N0::f0_WL
    @@ -65,8 +60,7 @@

    Functions

    -f0_WL This function should be included because it matches N0::f0_WL - +f0_WL This function should be included because it matches N0::f0_WL @@ -75,8 +69,7 @@

    Functions

    N0::f0_WL

    -This function should be included because it matches N0::f0_WL - +This function should be included because it matches N0::f0_WL
    @@ -96,8 +89,7 @@

    Synopsis

    N1

    -This namespace should extracted because it's implied by N1::N3_WL and N1::N4::f1_WL - +This namespace should extracted because it's implied by N1::N3_WL and N1::N4::f1_WL
    @@ -111,11 +103,9 @@

    Namespaces

    -N3_WL This namespace should extracted because it's explicitly included by N1::N3_WL - +N3_WL This namespace should extracted because it's explicitly included by N1::N3_WL -N4 This namespace should extracted because it's implied by N1::N4::f1_WL - +N4 This namespace should extracted because it's implied by N1::N4::f1_WL @@ -124,8 +114,7 @@

    Namespaces

    N1::N3_WL

    -This namespace should extracted because it's explicitly included by N1::N3_WL - +This namespace should extracted because it's explicitly included by N1::N3_WL
    @@ -139,8 +128,7 @@

    Functions

    -f1_WL This function should extracted because the namespace N1::N3_WL is included as a literal. - +f1_WL This function should extracted because the namespace N1::N3_WL is included as a literal. @@ -149,8 +137,7 @@

    Functions

    N1::N3_WL::f1_WL

    -This function should extracted because the namespace N1::N3_WL is included as a literal. - +This function should extracted because the namespace N1::N3_WL is included as a literal.
    @@ -170,8 +157,7 @@

    Synopsis

    N1::N4

    -This namespace should extracted because it's implied by N1::N4::f1_WL - +This namespace should extracted because it's implied by N1::N4::f1_WL
    @@ -185,8 +171,7 @@

    Functions

    -f1_WL This function should extracted because it matches N1::N4::f1_WL - +f1_WL This function should extracted because it matches N1::N4::f1_WL @@ -195,8 +180,7 @@

    Functions

    N1::N4::f1_WL

    -This function should extracted because it matches N1::N4::f1_WL - +This function should extracted because it matches N1::N4::f1_WL
    @@ -216,8 +200,7 @@

    Synopsis

    N5

    -This namespace should extracted because it's implied by N5::N6::*7 - +This namespace should extracted because it's implied by N5::N6::*7
    @@ -231,8 +214,7 @@

    Namespaces

    -N6 This namespace should extracted because it's implied by N5::N6::*7 - +N6 This namespace should extracted because it's implied by N5::N6::*7 @@ -241,8 +223,7 @@

    Namespaces

    N5::N6

    -This namespace should extracted because it's implied by N5::N6::*7 - +This namespace should extracted because it's implied by N5::N6::*7
    @@ -256,11 +237,9 @@

    Namespaces

    -M7 This namespace should be included because it matches N5::N6::*7 - +M7 This namespace should be included because it matches N5::N6::*7 -N7 This namespace should be included because it matches N5::N6::*7 - +N7 This namespace should be included because it matches N5::N6::*7 @@ -269,8 +248,7 @@

    Namespaces

    N5::N6::M7

    -This namespace should be included because it matches N5::N6::*7 - +This namespace should be included because it matches N5::N6::*7
    @@ -284,8 +262,7 @@

    Functions

    -f2_WL This function should be included because it's a member of M7 , which matches N5::N6::*7 - +f2_WL This function should be included because it's a member of M7, which matches N5::N6::*7 @@ -294,8 +271,7 @@

    Functions

    N5::N6::M7::f2_WL

    -This function should be included because it's a member of M7 , which matches N5::N6::*7 - +This function should be included because it's a member of M7, which matches N5::N6::*7
    @@ -315,8 +291,7 @@

    Synopsis

    N5::N6::N7

    -This namespace should be included because it matches N5::N6::*7 - +This namespace should be included because it matches N5::N6::*7
    @@ -330,8 +305,7 @@

    Functions

    -f2_WL This function should be included because it's a member of N7 , which matches N5::N6::*7 - +f2_WL This function should be included because it's a member of N7, which matches N5::N6::*7 @@ -340,8 +314,7 @@

    Functions

    N5::N6::N7::f2_WL

    -This function should be included because it's a member of N7 , which matches N5::N6::*7 - +This function should be included because it's a member of N7, which matches N5::N6::*7
    @@ -361,8 +334,7 @@

    Synopsis

    C

    -This namespace should be included because it strictly matches C - +This namespace should be included because it strictly matches C
    @@ -386,8 +358,7 @@

    Types

    -D This struct should be included because it's a member of C - +D This struct should be included because it's a member of C @@ -401,8 +372,7 @@

    Member Functions

    -f0_WL This function should be included because it's a member of C - +f0_WL This function should be included because it's a member of C @@ -413,8 +383,7 @@

    Member Functions

    C::D

    -This struct should be included because it's a member of C - +This struct should be included because it's a member of C
    @@ -438,8 +407,7 @@

    Member Functions

    -f1_WL This function should be included because it's a member of D - +f1_WL This function should be included because it's a member of D @@ -450,8 +418,7 @@

    Member Functions

    C::D::f1_WL

    -This function should be included because it's a member of D - +This function should be included because it's a member of D
    @@ -471,8 +438,7 @@

    Synopsis

    C::f0_WL

    -This function should be included because it's a member of C - +This function should be included because it's a member of C
    diff --git a/test-files/golden-tests/javadoc/brief/brief-1.adoc b/test-files/golden-tests/javadoc/brief/brief-1.adoc index 733a6aab3a..ad1dea8fc6 100644 --- a/test-files/golden-tests/javadoc/brief/brief-1.adoc +++ b/test-files/golden-tests/javadoc/brief/brief-1.adoc @@ -57,7 +57,7 @@ f6(); === Description -many lined *bold* what will happen? +many lined *bold* what will happen? diff --git a/test-files/golden-tests/javadoc/brief/brief-1.html b/test-files/golden-tests/javadoc/brief/brief-1.html index a96e99552d..6df6218961 100644 --- a/test-files/golden-tests/javadoc/brief/brief-1.html +++ b/test-files/golden-tests/javadoc/brief/brief-1.html @@ -19,11 +19,9 @@

    Functions

    -f5 brief bold it continues to the line. - +f5 brief bold it continues to the line. -f6 brief - +f6 brief @@ -32,8 +30,7 @@

    Functions

    f5

    -brief bold it continues to the line. - +brief bold it continues to the line.
    @@ -53,8 +50,7 @@

    Synopsis

    f6

    -brief - +brief
    @@ -71,9 +67,7 @@

    Synopsis

    Description

    -

    many lined bold what will happen?

    - - +

    many lined bold what will happen?

    diff --git a/test-files/golden-tests/javadoc/brief/brief-1.xml b/test-files/golden-tests/javadoc/brief/brief-1.xml index 5349af63fe..5d73958b50 100644 --- a/test-files/golden-tests/javadoc/brief/brief-1.xml +++ b/test-files/golden-tests/javadoc/brief/brief-1.xml @@ -19,9 +19,9 @@ brief - many lined + many lined bold - what will happen? + what will happen? diff --git a/test-files/golden-tests/javadoc/brief/brief-2.adoc b/test-files/golden-tests/javadoc/brief/brief-2.adoc index 05dc279cb7..89b5fe8b07 100644 --- a/test-files/golden-tests/javadoc/brief/brief-2.adoc +++ b/test-files/golden-tests/javadoc/brief/brief-2.adoc @@ -22,7 +22,7 @@ | brief | <> -| brief x +| brief x | <> | brief @@ -87,7 +87,7 @@ f3(); == f4 -brief x +brief x === Synopsis diff --git a/test-files/golden-tests/javadoc/brief/brief-2.html b/test-files/golden-tests/javadoc/brief/brief-2.html index 7d1241b5e1..bf3cd51fe7 100644 --- a/test-files/golden-tests/javadoc/brief/brief-2.html +++ b/test-files/golden-tests/javadoc/brief/brief-2.html @@ -19,23 +19,17 @@

    Functions

    -f1 brief - +f1 brief -f2 brief - +f2 brief -f3 brief - +f3 brief -f4 brief x - +f4 brief x -f5 brief - +f5 brief -f6 brief - +f6 brief @@ -44,8 +38,7 @@

    Functions

    f1

    -brief - +brief
    @@ -65,8 +58,7 @@

    Synopsis

    f2

    -brief - +brief
    @@ -86,8 +78,7 @@

    Synopsis

    f3

    -brief - +brief
    @@ -107,8 +98,7 @@

    Synopsis

    f4

    -brief x - +brief x
    @@ -125,17 +115,14 @@

    Synopsis

    Description

    -

    brief

    - - +

    brief

    f5

    -brief - +brief
    @@ -155,8 +142,7 @@

    Synopsis

    f6

    -brief - +brief
    @@ -173,9 +159,7 @@

    Synopsis

    Description

    -

    desc

    - - +

    desc

    diff --git a/test-files/golden-tests/javadoc/brief/brief-2.xml b/test-files/golden-tests/javadoc/brief/brief-2.xml index 34a452b49a..14e4c7f640 100644 --- a/test-files/golden-tests/javadoc/brief/brief-2.xml +++ b/test-files/golden-tests/javadoc/brief/brief-2.xml @@ -31,7 +31,7 @@ - brief x + brief x brief diff --git a/test-files/golden-tests/javadoc/brief/brief-3.html b/test-files/golden-tests/javadoc/brief/brief-3.html index 468cd4ff85..c3a78108c2 100644 --- a/test-files/golden-tests/javadoc/brief/brief-3.html +++ b/test-files/golden-tests/javadoc/brief/brief-3.html @@ -19,8 +19,7 @@

    Functions

    -f f overloads - +f f overloads @@ -29,8 +28,7 @@

    Functions

    f

    -f overloads - +f overloads
    @@ -38,11 +36,7 @@

    f

    Synopses

    Declared in <brief-3.cpp>
    -

    - Integer overload. - -

    - +

    Integer overload.

     
@@ -51,11 +45,7 @@ 
    Synopses
    » more... -

    - Integer overload. - -

    - +

    Integer overload.

     
@@ -64,11 +54,7 @@ 
    Synopses
    » more... -

    - C string overload. - -

    - +

    C string overload.

     
@@ -77,11 +63,7 @@ 
    Synopses
    » more... -

    - C string overload. - -

    - +

    C string overload.

     
@@ -97,8 +79,7 @@ 
    Synopses
    
 
    
 
    f
    
 
    
-Integer overload.
-
+Integer overload.
 
 
    
 
    
@@ -115,17 +96,14 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    More info
    
-
-
+
    More info
    
 
    
 
 
    
 
    
 
    f
    
 
    
-Integer overload.
-
+Integer overload.
 
 
    
 
    
@@ -145,8 +123,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-C string overload.
-
+C string overload.
 
 
    
 
    
@@ -163,17 +140,14 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    More info
    
-
-
+
    More info
    
 
    
 
 
    
 
    
 
    f
    
 
    
-C string overload.
-
+C string overload.
 
 
    
 
    
diff --git a/test-files/golden-tests/javadoc/brief/brief-3.xml b/test-files/golden-tests/javadoc/brief/brief-3.xml
index 41d0de94e6..45d3ec6807 100644
--- a/test-files/golden-tests/javadoc/brief/brief-3.xml
+++ b/test-files/golden-tests/javadoc/brief/brief-3.xml
@@ -9,7 +9,7 @@
     
     
       
-        Integer overload. 
+        Integer overload.
       
       
    
         More info
@@ -36,7 +36,7 @@
     
     
       
-        C string overload. 
+        C string overload.
       
       
    
         More info
diff --git a/test-files/golden-tests/javadoc/brief/brief-5.html b/test-files/golden-tests/javadoc/brief/brief-5.html
index 81268ee495..b413154e3c 100644
--- a/test-files/golden-tests/javadoc/brief/brief-5.html
+++ b/test-files/golden-tests/javadoc/brief/brief-5.html
@@ -19,21 +19,17 @@ 
    Functions
    
 
 
 
-f0 brief
-
+f0 brief
 
-f1 
+f1 
 
-f2 
+f2 
 
-f3 brief
-
+f3 brief
 
-f4 brief
-
+f4 brief
 
-f5 brief
-
+f5 brief
 
 
 
@@ -42,8 +38,7 @@ 
    Functions
    
 
    
 
    f0
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -95,8 +90,7 @@ 
    Synopsis
    
 
    
 
    f3
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -116,8 +110,7 @@ 
    Synopsis
    
 
    
 
    f4
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -137,8 +130,7 @@ 
    Synopsis
    
 
    
 
    f5
    
 
    
-brief
-
+brief
 
 
    
 
    
diff --git a/test-files/golden-tests/javadoc/brief/brief-5.xml b/test-files/golden-tests/javadoc/brief/brief-5.xml
index 5d68d7b9d4..eb68452906 100644
--- a/test-files/golden-tests/javadoc/brief/brief-5.xml
+++ b/test-files/golden-tests/javadoc/brief/brief-5.xml
@@ -12,17 +12,9 @@
   
   
     
-    
-      
-      
-    
   
   
     
-    
-      
-      
-    
   
   
     
diff --git a/test-files/golden-tests/javadoc/brief/brief-6.html b/test-files/golden-tests/javadoc/brief/brief-6.html
index a9e42ccd5e..f160ab1eb3 100644
--- a/test-files/golden-tests/javadoc/brief/brief-6.html
+++ b/test-files/golden-tests/javadoc/brief/brief-6.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f0 brief
-
+f0 brief
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f0
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -47,9 +45,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    desc
    
-
-
+
    desc
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/code/code.html b/test-files/golden-tests/javadoc/code/code.html
index 9848ad4a1b..ae0d1049bf 100644
--- a/test-files/golden-tests/javadoc/code/code.html
+++ b/test-files/golden-tests/javadoc/code/code.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f brief
-
+f brief
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -47,7 +45,7 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    This description contains code:
    
+
    This description contains code:
    
 
 // code comment
 // code comment
@@ -59,8 +57,6 @@ 
    Description
    
     return v.result();
 }
     
-
-
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/code/code.xml b/test-files/golden-tests/javadoc/code/code.xml
index 558cff6eac..57c06dbd9b 100644
--- a/test-files/golden-tests/javadoc/code/code.xml
+++ b/test-files/golden-tests/javadoc/code/code.xml
@@ -12,15 +12,15 @@
         This description contains code:
       
       
-            // code comment
-            // code comment
-            template < class T >
-            auto
-            algorithm( T&& v = {} ) ->
-                typename T::result_type
-            {
-                return v.result();
-            }
+        // code comment
+        // code comment
+        template < class T >
+        auto
+        algorithm( T&& v = {} ) ->
+            typename T::result_type
+        {
+            return v.result();
+        }
       
     
   
diff --git a/test-files/golden-tests/javadoc/copybrief/copybrief.html b/test-files/golden-tests/javadoc/copybrief/copybrief.html
index 023018ae5e..1384b055eb 100644
--- a/test-files/golden-tests/javadoc/copybrief/copybrief.html
+++ b/test-files/golden-tests/javadoc/copybrief/copybrief.html
@@ -19,14 +19,11 @@ 
    Functions
    
 
 
 
-f1 brief1
-
+f1 brief1
 
-f2 brief1
-
+f2 brief1
 
-f3 brief1
-
+f3 brief1
 
 
 
@@ -35,8 +32,7 @@ 
    Functions
    
 
    
 
    f1
    
 
    
-brief1
-
+brief1
 
 
    
 
    
@@ -56,8 +52,7 @@ 
    Synopsis
    
 
    
 
    f2
    
 
    
-brief1
-
+brief1
 
 
    
 
    
@@ -77,8 +72,7 @@ 
    Synopsis
    
 
    
 
    f3
    
 
    
-brief1
-
+brief1
 
 
    
 
    
@@ -95,9 +89,7 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    f2
    
-
-
+
    f2
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/copydetails/copydetails.adoc b/test-files/golden-tests/javadoc/copydetails/copydetails.adoc
index 70a49e8160..fe2111acd0 100644
--- a/test-files/golden-tests/javadoc/copydetails/copydetails.adoc
+++ b/test-files/golden-tests/javadoc/copydetails/copydetails.adoc
@@ -50,7 +50,7 @@ dest(
 
 Documentation prefix for dest only.
 
-This is the documentation from the    source function.
+This is the documentation from the source function.
 
 Documentation suffix for dest only.
 
@@ -140,11 +140,11 @@ destOverride(
 
 Documentation prefix for dest only.
 
-This is the documentation from the    source function.
+This is the documentation from the source function.
 
 Documentation suffix for dest only.
 
-Parameter b is not copied because    it doesn't exist in the destination function.
+Parameter b is not copied because it doesn't exist in the destination function.
 
 
 
@@ -245,7 +245,7 @@ source(
 === Description
 
 
-This is the documentation from the    source function.
+This is the documentation from the source function.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydetails/copydetails.html b/test-files/golden-tests/javadoc/copydetails/copydetails.html
index dc1cdbfe44..40cc283df2 100644
--- a/test-files/golden-tests/javadoc/copydetails/copydetails.html
+++ b/test-files/golden-tests/javadoc/copydetails/copydetails.html
@@ -19,14 +19,11 @@ 
    Functions
    
 
 
 
-dest Destination doc function
-
+dest Destination doc function
 
-destOverride Destination doc function
-
+destOverride Destination doc function
 
-source Source doc function
-
+source Source doc function
 
 
 
@@ -35,8 +32,7 @@ 
    Functions
    
 
    
 
    dest
    
 
    
-Destination doc function
-
+Destination doc function
 
 
    
 
    
@@ -58,16 +54,13 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    Documentation prefix for dest only.
    
-
    This is the documentation from the    source function.
    
-
    Documentation suffix for dest only.
    
-
-
+
    Documentation prefix for dest only.
    
+
    This is the documentation from the source function.
    
+
    Documentation suffix for dest only.
    
 
    
 
    
 
    Return Value
    
-
    A nice integer
    
-
+A nice integer
 
    
 
    
 
    Template Parameters
    
@@ -81,13 +74,11 @@ 
    Template Parameters
    
 
 
 A
-
    The template parameter A.
    
-
+The template parameter A.
 
 
 B
-
    The template parameter B.
    
-
+The template parameter B.
 
 
 
@@ -104,13 +95,11 @@ 
    Parameters
    
 
 
 a
-
    The parameter a.
    
-
+The parameter a.
 
 
 b
-
    The parameter b.
    
-
+The parameter b.
 
 
 
@@ -118,29 +107,25 @@ 
    Parameters
    
 
    
 
    Preconditions
    
 
      
-
    • a must be greater than 0.
      
-
      • 
+
    • a must be greater than 0.
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • The return value is greater than 0.
      
-
      • 
+
    • The return value is greater than 0.
      • 
 
    
 
    
 
    
 
    See Also
    
-
    dest
    
-
    
+
    dest
    
 
    
 
    
 
    
 
    
 
    destOverride
    
 
    
-Destination doc function
-
+Destination doc function
 
 
    
 
    
@@ -164,12 +149,10 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation prefix for dest only.
    
-
    This is the documentation from the    source function.
    
-
    Documentation suffix for dest only.
    
-
    Parameter b is not copied because    it doesn't exist in the destination function.
    
-
-
+
    Documentation prefix for dest only.
    
+
    This is the documentation from the source function.
    
+
    Documentation suffix for dest only.
    
+
    Parameter b is not copied because it doesn't exist in the destination function.
    
 
    
 
    
 
    Exceptions
    
@@ -183,16 +166,14 @@ 
    Exceptions
    
 
 
 std::runtime_error
-
    Overwrites the exception.
    
-
+Overwrites the exception.
 
 
 
 
    
 
    
 
    Return Value
    
-
    An integer meaning something else.
    
-
+An integer meaning something else.
 
    
 
    
 
    Template Parameters
    
@@ -206,18 +187,15 @@ 
    Template Parameters
    
 
 
 A
-
    Overwrites the template parameter A.
    
-
+Overwrites the template parameter A.
 
 
 C
-
    The template parameter C.
    
-
+The template parameter C.
 
 
 D
-
    The template parameter D.
    
-
+The template parameter D.
 
 
 
@@ -234,18 +212,15 @@ 
    Parameters
    
 
 
 a
-
    Overwrites the parameter a.
    
-
+Overwrites the parameter a.
 
 
 c
-
    The parameter c.
    
-
+The parameter c.
 
 
 d
-
    The parameter d.
    
-
+The parameter d.
 
 
 
@@ -253,29 +228,25 @@ 
    Parameters
    
 
    
 
    Preconditions
    
 
      
-
    • overriden precondition
      
-
      • 
+
    • overriden precondition
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • overriden postcondition
      
-
      • 
+
    • overriden postcondition
      • 
 
    
 
    
 
    
 
    See Also
    
-
    source
    
-
    
+
    source
    
 
    
 
    
 
    
 
    
 
    source
    
 
    
-Source doc function
-
+Source doc function
 
 
    
 
    
@@ -297,9 +268,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This is the documentation from the    source function.
    
-
-
+
    This is the documentation from the source function.
    
 
    
 
    
 
    Exceptions
    
@@ -313,16 +282,14 @@ 
    Exceptions
    
 
 
 std::runtime_error
-
    If something goes wrong.
    
-
+If something goes wrong.
 
 
 
 
    
 
    
 
    Return Value
    
-
    A nice integer
    
-
+A nice integer
 
    
 
    
 
    Template Parameters
    
@@ -336,13 +303,11 @@ 
    Template Parameters
    
 
 
 A
-
    The template parameter A.
    
-
+The template parameter A.
 
 
 B
-
    The template parameter B.
    
-
+The template parameter B.
 
 
 
@@ -359,13 +324,11 @@ 
    Parameters
    
 
 
 a
-
    The parameter a.
    
-
+The parameter a.
 
 
 b
-
    The parameter b.
    
-
+The parameter b.
 
 
 
@@ -373,21 +336,18 @@ 
    Parameters
    
 
    
 
    Preconditions
    
 
      
-
    • a must be greater than 0.
      
-
      • 
+
    • a must be greater than 0.
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • The return value is greater than 0.
      
-
      • 
+
    • The return value is greater than 0.
      • 
 
    
 
    
 
    
 
    See Also
    
-
    dest
    
-
    
+
    dest
    
 
    
 
    
 
diff --git a/test-files/golden-tests/javadoc/copydetails/copydetails.xml b/test-files/golden-tests/javadoc/copydetails/copydetails.xml
index c7c30cf357..7ed17a8aa0 100644
--- a/test-files/golden-tests/javadoc/copydetails/copydetails.xml
+++ b/test-files/golden-tests/javadoc/copydetails/copydetails.xml
@@ -24,7 +24,7 @@
           Documentation prefix for dest only.
         
         
-          This is the documentation from the    source function.
+          This is the documentation from the source function.
         
         
           Documentation suffix for dest only.
@@ -33,22 +33,22 @@
           A nice integer
         
         
-          The parameter a.    
+          The parameter a.
         
         
-          The parameter b.    
+          The parameter b.
         
         
-          The template parameter A.    
+          The template parameter A.
         
         
-          The template parameter B.    
+          The template parameter B.
         
         
           dest
         
         
    -          a must be greater than 0.    
+          a must be greater than 0.
         
    
         
           The return value is greater than 0.
@@ -82,34 +82,34 @@
           Documentation prefix for dest only.
             
         
-          This is the documentation from the    source function.
+          This is the documentation from the source function.
         
         
           Documentation suffix for dest only.
         
         
-          Parameter b is not copied because    it doesn't exist in the destination function.
+          Parameter b is not copied because it doesn't exist in the destination function.
         
         
           An integer meaning something else.
         
         
-          Overwrites the parameter a.    
+          Overwrites the parameter a.
         
         
-          The parameter c.    
+          The parameter c.
         
         
-          The parameter d.    
+          The parameter d.
         
         
-          Overwrites the template parameter A.    
+          Overwrites the template parameter A.
         
         
-          The template parameter C.    
+          The template parameter C.
         
         
-          The template parameter D.    
+          The template parameter D.
         
         
           Overwrites the exception.
@@ -118,7 +118,7 @@
           source
         
         
    -          overriden precondition    
+          overriden precondition
         
    
         
           overriden postcondition
@@ -145,22 +145,22 @@
           Source doc function
         
         
-          This is the documentation from the    source function.
+          This is the documentation from the source function.
         
         
           A nice integer
         
         
-          The parameter a.    
+          The parameter a.
         
         
-          The parameter b.    
+          The parameter b.
         
         
-          The template parameter A.    
+          The template parameter A.
         
         
-          The template parameter B.    
+          The template parameter B.
         
         
           If something goes wrong.
@@ -169,7 +169,7 @@
           dest
         
         
    -          a must be greater than 0.    
+          a must be greater than 0.
         
    
         
           The return value is greater than 0.
diff --git a/test-files/golden-tests/javadoc/copydoc/conversion.html b/test-files/golden-tests/javadoc/copydoc/conversion.html
index 7f79dc5f32..3b8ba5f83f 100644
--- a/test-files/golden-tests/javadoc/copydoc/conversion.html
+++ b/test-files/golden-tests/javadoc/copydoc/conversion.html
@@ -51,14 +51,11 @@ 
    Member Functions
    
 
 
 
-operator= Convert a string to A
-
+operator= Convert a string to A
 
-operator string_type Convert A to a string
-
+operator string_type Convert A to a string
 
-operator string_view_type Convert A to a string
-
+operator string_view_type Convert A to a string
 
 
 
@@ -69,8 +66,7 @@ 
    Member Functions
    
 
    
 
    A::operator=
    
 
    
-Convert a string to A
-
+Convert a string to A
 
 
    
 
    
@@ -78,11 +74,7 @@ 
    A::operator=
    
 
    Synopses
    
 
    
 Declared in <conversion.cpp>
    
-
    
-    Convert a string to A
-
-
    
-
+
    Convert a string to A
    
 
 
     
@@ -91,11 +83,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Convert a string to A
-
-
    
-
+
    Convert a string to A
    
 
 
     
@@ -108,8 +96,7 @@ 
    Synopses
    
 
 
    
 
    Return Value
    
-
    A representation of the string
    
-
+A representation of the string
 
    
 
    
 
    Parameters
    
@@ -123,8 +110,7 @@ 
    Parameters
    
 
 
 other
-
    The string to convert
    
-
+The string to convert
 
 
 
@@ -134,8 +120,7 @@ 
    Parameters
    
 
    
 
    A::operator=
    
 
    
-Convert a string to A
-
+Convert a string to A
 
 
    
 
    
@@ -152,8 +137,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A representation of the string
    
-
+A representation of the string
 
    
 
    
 
    Parameters
    
@@ -167,8 +151,7 @@ 
    Parameters
    
 
 
 other
-
    The string to convert
    
-
+The string to convert
 
 
 
@@ -178,8 +161,7 @@ 
    Parameters
    
 
    
 
    A::operator=
    
 
    
-Convert a string to A
-
+Convert a string to A
 
 
    
 
    
@@ -196,8 +178,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A representation of the string
    
-
+A representation of the string
 
    
 
    
 
    Parameters
    
@@ -211,8 +192,7 @@ 
    Parameters
    
 
 
 other
-
    The string to convert
    
-
+The string to convert
 
 
 
@@ -222,8 +202,7 @@ 
    Parameters
    
 
    
 
    A::operator string_type
    
 
    
-Convert A to a string
-
+Convert A to a string
 
 
    
 
    
@@ -239,16 +218,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A string representation of A
    
-
+A string representation of A
 
    
 
 
    
 
    
 
    A::operator string_view_type
    
 
    
-Convert A to a string
-
+Convert A to a string
 
 
    
 
    
@@ -264,8 +241,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A string representation of A
    
-
+A string representation of A
 
    
 
 
    
diff --git a/test-files/golden-tests/javadoc/copydoc/conversion.xml b/test-files/golden-tests/javadoc/copydoc/conversion.xml
index 765b31c724..30c110a9f3 100644
--- a/test-files/golden-tests/javadoc/copydoc/conversion.xml
+++ b/test-files/golden-tests/javadoc/copydoc/conversion.xml
@@ -25,7 +25,7 @@
           A representation of the string
         
         
-          The string to convert        
+          The string to convert
         
       
     
@@ -50,7 +50,7 @@
           A representation of the string
         
         
-          The string to convert        
+          The string to convert
         
       
     
diff --git a/test-files/golden-tests/javadoc/copydoc/decay-params.adoc b/test-files/golden-tests/javadoc/copydoc/decay-params.adoc
index 4712a5f0b5..19bd9056d6 100644
--- a/test-files/golden-tests/javadoc/copydoc/decay-params.adoc
+++ b/test-files/golden-tests/javadoc/copydoc/decay-params.adoc
@@ -41,7 +41,7 @@ bar(int* a);
 === Description
 
 
-This is the function original documentation    for the foo function with an array parameter.
+This is the function original documentation for the foo function with an array parameter.
 
 
 
@@ -142,7 +142,7 @@ foo();
 === Description
 
 
-`bar` should not copy this documentation    just because it has the same name and is    simpler.
+`bar` should not copy this documentation just because it has the same name and is simpler.
 
 
 
@@ -166,7 +166,7 @@ foo(int a);
 === Description
 
 
-`bar` should not copy this documentation    just because it has the same number of    parameters.
+`bar` should not copy this documentation just because it has the same number of parameters.
 
 
 
@@ -202,7 +202,7 @@ foo(int a[3]);
 === Description
 
 
-This is the function original documentation    for the foo function with an array parameter.
+This is the function original documentation for the foo function with an array parameter.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/decay-params.html b/test-files/golden-tests/javadoc/copydoc/decay-params.html
index 0c95af19e6..69f5bfee67 100644
--- a/test-files/golden-tests/javadoc/copydoc/decay-params.html
+++ b/test-files/golden-tests/javadoc/copydoc/decay-params.html
@@ -19,11 +19,9 @@ 
    Functions
    
 
 
 
-bar Brief from foo()
-
+bar Brief from foo()
 
-foo foo overloads
-
+foo foo overloads
 
 
 
@@ -32,8 +30,7 @@ 
    Functions
    
 
    
 
    bar
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -51,14 +48,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This is the function original documentation    for the foo function with an array parameter.
    
-
-
+
    This is the function original documentation for the foo function with an array parameter.
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
    
 
    Parameters
    
@@ -72,8 +66,7 @@ 
    Parameters
    
 
 
 a
-
    An array of integers.
    
-
+An array of integers.
 
 
 
@@ -83,8 +76,7 @@ 
    Parameters
    
 
    
 
    foo
    
 
    
-foo overloads
-
+foo overloads
 
 
    
 
    
@@ -92,11 +84,7 @@ 
    foo
    
 
    Synopses
    
 
    
 Declared in <decay-params.cpp>
    
-
    
-    We should not copy this doc
-
-
    
-
+
    We should not copy this doc
    
 
 
     
@@ -105,11 +93,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    We should not copy this doc
-
-
    
-
+
    We should not copy this doc
    
 
 
     
@@ -118,11 +102,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Brief from foo()
-
-
    
-
+
    Brief from foo()
    
 
 
     
@@ -136,8 +116,7 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
    
 
    Parameters
    
@@ -151,8 +130,7 @@ 
    Parameters
    
 
 
 a
-
    An integer.
    
-
+An integer.
 
 
 
@@ -162,8 +140,7 @@ 
    Parameters
    
 
    
 
    foo
    
 
    
-We should not copy this doc
-
+We should not copy this doc
 
 
    
 
    
@@ -180,17 +157,14 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    bar should not copy this documentation    just because it has the same name and is    simpler.
    
-
-
+
    bar should not copy this documentation just because it has the same name and is simpler.
    
 
    
 
 
    
 
    
 
    foo
    
 
    
-We should not copy this doc
-
+We should not copy this doc
 
 
    
 
    
@@ -207,9 +181,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    bar should not copy this documentation    just because it has the same number of    parameters.
    
-
-
+
    bar should not copy this documentation just because it has the same number of parameters.
    
 
    
 
    
 
    Parameters
    
@@ -223,8 +195,7 @@ 
    Parameters
    
 
 
 a
-
    An integer.
    
-
+An integer.
 
 
 
@@ -234,8 +205,7 @@ 
    Parameters
    
 
    
 
    foo
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -253,14 +223,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This is the function original documentation    for the foo function with an array parameter.
    
-
-
+
    This is the function original documentation for the foo function with an array parameter.
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
    
 
    Parameters
    
@@ -274,8 +241,7 @@ 
    Parameters
    
 
 
 a
-
    An array of integers.
    
-
+An array of integers.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/decay-params.xml b/test-files/golden-tests/javadoc/copydoc/decay-params.xml
index bc59afe8b7..6e7ebd93ac 100644
--- a/test-files/golden-tests/javadoc/copydoc/decay-params.xml
+++ b/test-files/golden-tests/javadoc/copydoc/decay-params.xml
@@ -19,13 +19,13 @@
         foo()
       
       
-        This is the function original documentation    for the foo function with an array parameter.
+        This is the function original documentation for the foo function with an array parameter.
       
       
         A boolean value.
       
       
-        An array of integers.    
+        An array of integers.
       
     
   
@@ -37,7 +37,7 @@
       
       
         bar
-         should not copy this documentation    just because it has the same name and is    simpler.
+         should not copy this documentation just because it has the same name and is simpler.
       
     
   
@@ -52,7 +52,7 @@
       
       
         bar
-         should not copy this documentation    just because it has the same number of    parameters.
+         should not copy this documentation just because it has the same number of parameters.
       
       
         An integer.
@@ -76,13 +76,13 @@
         foo()
       
       
-        This is the function original documentation    for the foo function with an array parameter.
+        This is the function original documentation for the foo function with an array parameter.
       
       
         A boolean value.
       
       
-        An array of integers.    
+        An array of integers.
       
     
   
diff --git a/test-files/golden-tests/javadoc/copydoc/fundamental.html b/test-files/golden-tests/javadoc/copydoc/fundamental.html
index 2fd75607c2..4d5c45f31f 100644
--- a/test-files/golden-tests/javadoc/copydoc/fundamental.html
+++ b/test-files/golden-tests/javadoc/copydoc/fundamental.html
@@ -19,14 +19,11 @@ 
    Functions
    
 
 
 
-f f overloads
-
+f f overloads
 
-g Brief
-
+g Brief
 
-h Brief
-
+h Brief
 
 
 
@@ -35,8 +32,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-f overloads
-
+f overloads
 
 
    
 
    
@@ -44,11 +40,7 @@ 
    f
    
 
    Synopses
    
 
    
 Declared in <fundamental.cpp>
    
-
    
-    Fail
-
-
    
-
+
    Fail
    
 
 
     
@@ -57,11 +49,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Brief
-
-
    
-
+
    Brief
    
 
 
     
@@ -84,8 +72,7 @@ 
    Parameters
    
 
 
 a
-
    Fail param
    
-
+Fail param
 
 
 
@@ -95,8 +82,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Fail
-
+Fail
 
 
    
 
    
@@ -123,8 +109,7 @@ 
    Parameters
    
 
 
 a
-
    Fail param
    
-
+Fail param
 
 
 
@@ -134,8 +119,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -152,9 +136,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Details
    
-
-
+
    Details
    
 
    
 
    
 
    Parameters
    
@@ -168,8 +150,7 @@ 
    Parameters
    
 
 
 a
-
    Param description
    
-
+Param description
 
 
 
@@ -179,8 +160,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -197,9 +177,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Details
    
-
-
+
    Details
    
 
    
 
    
 
    Parameters
    
@@ -213,8 +191,7 @@ 
    Parameters
    
 
 
 a
-
    Param description
    
-
+Param description
 
 
 
@@ -224,8 +201,7 @@ 
    Parameters
    
 
    
 
    h
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -242,9 +218,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Details
    
-
-
+
    Details
    
 
    
 
    
 
    Parameters
    
@@ -258,8 +232,7 @@ 
    Parameters
    
 
 
 a
-
    Param description
    
-
+Param description
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/no-param.adoc b/test-files/golden-tests/javadoc/copydoc/no-param.adoc
index 1d36c6313d..f9f23a551d 100644
--- a/test-files/golden-tests/javadoc/copydoc/no-param.adoc
+++ b/test-files/golden-tests/javadoc/copydoc/no-param.adoc
@@ -44,9 +44,9 @@ copyFromNoParam();
 === Description
 
 
-This is the function original documentation    for the foo function with no parameters.
+This is the function original documentation for the foo function with no parameters.
 
-This documentation is copied from the    page containing the foo overload with    no parameters.
+This documentation is copied from the page containing the foo overload with no parameters.
 
 
 
@@ -76,7 +76,7 @@ copyfromOverloads();
 === Description
 
 
-This documentation is copied from the    page containing all overloads of foo.
+This documentation is copied from the page containing all overloads of foo.
 
 
 
@@ -157,7 +157,7 @@ foo();
 === Description
 
 
-This is the function original documentation    for the foo function with no parameters.
+This is the function original documentation for the foo function with no parameters.
 
 
 
@@ -187,7 +187,7 @@ foo(char ch);
 === Description
 
 
-This is the function original documentation    for the foo function with no parameters.
+This is the function original documentation for the foo function with no parameters.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/no-param.html b/test-files/golden-tests/javadoc/copydoc/no-param.html
index b84360c7e1..570dd45e87 100644
--- a/test-files/golden-tests/javadoc/copydoc/no-param.html
+++ b/test-files/golden-tests/javadoc/copydoc/no-param.html
@@ -19,14 +19,11 @@ 
    Functions
    
 
 
 
-copyFromNoParam Brief from foo()
-
+copyFromNoParam Brief from foo()
 
-copyfromOverloads Brief from foo()
-
+copyfromOverloads Brief from foo()
 
-foo Brief from foo()
-
+foo Brief from foo()
 
 
 
@@ -35,8 +32,7 @@ 
    Functions
    
 
    
 
    copyFromNoParam
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -54,23 +50,19 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This is the function original documentation    for the foo function with no parameters.
    
-
    This documentation is copied from the    page containing the foo overload with    no parameters.
    
-
-
+
    This is the function original documentation for the foo function with no parameters.
    
+
    This documentation is copied from the page containing the foo overload with no parameters.
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
 
    
 
    
 
    copyfromOverloads
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -88,22 +80,18 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This documentation is copied from the    page containing all overloads of foo.
    
-
-
+
    This documentation is copied from the page containing all overloads of foo.
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
 
    
 
    
 
    foo
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -111,11 +99,7 @@ 
    foo
    
 
    Synopses
    
 
    
 Declared in <no-param.cpp>
    
-
    
-    Brief from foo()
-
-
    
-
+
    Brief from foo()
    
 
 
     
@@ -125,11 +109,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Brief from foo()
-
-
    
-
+
    Brief from foo()
    
 
 
     
@@ -143,8 +123,7 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
    
 
    Parameters
    
@@ -158,8 +137,7 @@ 
    Parameters
    
 
 
 ch
-
    A character.
    
-
+A character.
 
 
 
@@ -169,8 +147,7 @@ 
    Parameters
    
 
    
 
    foo
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -188,22 +165,18 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This is the function original documentation    for the foo function with no parameters.
    
-
-
+
    This is the function original documentation for the foo function with no parameters.
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
 
    
 
    
 
    foo
    
 
    
-Brief from foo()
-
+Brief from foo()
 
 
    
 
    
@@ -221,14 +194,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This is the function original documentation    for the foo function with no parameters.
    
-
-
+
    This is the function original documentation for the foo function with no parameters.
    
 
    
 
    
 
    Return Value
    
-
    A boolean value.
    
-
+A boolean value.
 
    
 
    
 
    Parameters
    
@@ -242,8 +212,7 @@ 
    Parameters
    
 
 
 ch
-
    A character.
    
-
+A character.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/no-param.xml b/test-files/golden-tests/javadoc/copydoc/no-param.xml
index c99df570f5..54f024ed58 100644
--- a/test-files/golden-tests/javadoc/copydoc/no-param.xml
+++ b/test-files/golden-tests/javadoc/copydoc/no-param.xml
@@ -14,10 +14,10 @@
         foo()
       
       
-        This is the function original documentation    for the foo function with no parameters.
+        This is the function original documentation for the foo function with no parameters.
       
       
-        This documentation is copied from the    page containing the foo overload with    no parameters.
+        This documentation is copied from the page containing the foo overload with no parameters.
       
       
         A boolean value.
@@ -36,7 +36,7 @@
         foo()
       
       
-        This documentation is copied from the    page containing all overloads of foo.
+        This documentation is copied from the page containing all overloads of foo.
       
       
         A boolean value.
@@ -55,7 +55,7 @@
         foo()
       
       
-        This is the function original documentation    for the foo function with no parameters.
+        This is the function original documentation for the foo function with no parameters.
       
       
         A boolean value.
@@ -77,7 +77,7 @@
         foo()
       
       
-        This is the function original documentation    for the foo function with no parameters.
+        This is the function original documentation for the foo function with no parameters.
       
       
         A boolean value.
diff --git a/test-files/golden-tests/javadoc/copydoc/operator-param.adoc b/test-files/golden-tests/javadoc/copydoc/operator-param.adoc
index 4ce9329a70..2cfd56e9af 100644
--- a/test-files/golden-tests/javadoc/copydoc/operator-param.adoc
+++ b/test-files/golden-tests/javadoc/copydoc/operator-param.adoc
@@ -115,7 +115,7 @@ operator()(char ch) const noexcept;
 === Description
 
 
-This function returns true if the        character is in the set, otherwise        it returns false.
+This function returns true if the character is in the set, otherwise it returns false.
 
 
 
@@ -156,7 +156,7 @@ operator()(unsigned char ch) const noexcept;
 === Description
 
 
-This function returns true if the        character is in the set, otherwise        it returns false.
+This function returns true if the character is in the set, otherwise it returns false.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/operator-param.html b/test-files/golden-tests/javadoc/copydoc/operator-param.html
index f63ab4b21e..5a02323ac8 100644
--- a/test-files/golden-tests/javadoc/copydoc/operator-param.html
+++ b/test-files/golden-tests/javadoc/copydoc/operator-param.html
@@ -47,8 +47,7 @@ 
    Member Functions
    
 
 
 
-operator() Return true if ch is in the character set.
-
+operator() Return true if ch is in the character set.
 
 
 
@@ -59,8 +58,7 @@ 
    Member Functions
    
 
    
 
    A::operator()
    
 
    
-Return true if ch is in the character set.
-
+Return true if ch is in the character set.
 
 
    
 
    
@@ -68,11 +66,7 @@ 
    A::operator()
    
 
    Synopses
    
 
    
 Declared in <operator-param.cpp>
    
-
    
-    Return true if ch is in the character set.
-
-
    
-
+
    Return true if ch is in the character set.
    
 
 
     
@@ -82,11 +76,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Return true if ch is in the character set.
-
-
    
-
+
    Return true if ch is in the character set.
    
 
 
     
@@ -100,8 +90,7 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    True if ch is in the set, otherwise false.
    
-
+True if ch is in the set, otherwise false.
 
    
 
    
 
    Parameters
    
@@ -115,8 +104,7 @@ 
    Parameters
    
 
 
 ch
-
    The signed character to test.
    
-
+The signed character to test.
 
 
 
@@ -126,8 +114,7 @@ 
    Parameters
    
 
    
 
    A::operator()
    
 
    
-Return true if ch is in the character set.
-
+Return true if ch is in the character set.
 
 
    
 
    
@@ -145,14 +132,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This function returns true if the        character is in the set, otherwise        it returns false.
    
-
-
+
    This function returns true if the character is in the set, otherwise it returns false.
    
 
    
 
    
 
    Return Value
    
-
    True if ch is in the set, otherwise false.
    
-
+True if ch is in the set, otherwise false.
 
    
 
    
 
    Parameters
    
@@ -166,8 +150,7 @@ 
    Parameters
    
 
 
 ch
-
    The signed character to test.
    
-
+The signed character to test.
 
 
 
@@ -177,8 +160,7 @@ 
    Parameters
    
 
    
 
    A::operator()
    
 
    
-Return true if ch is in the character set.
-
+Return true if ch is in the character set.
 
 
    
 
    
@@ -196,14 +178,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This function returns true if the        character is in the set, otherwise        it returns false.
    
-
-
+
    This function returns true if the character is in the set, otherwise it returns false.
    
 
    
 
    
 
    Return Value
    
-
    True if ch is in the set, otherwise false.
    
-
+True if ch is in the set, otherwise false.
 
    
 
    
 
    Parameters
    
@@ -217,8 +196,7 @@ 
    Parameters
    
 
 
 ch
-
    The unsigned character to test.
    
-
+The unsigned character to test.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/operator-param.xml b/test-files/golden-tests/javadoc/copydoc/operator-param.xml
index 40b24cea35..742d01c42e 100644
--- a/test-files/golden-tests/javadoc/copydoc/operator-param.xml
+++ b/test-files/golden-tests/javadoc/copydoc/operator-param.xml
@@ -20,7 +20,7 @@
           Return true if ch is in the character set.
         
         
-          This function returns true if the        character is in the set, otherwise        it returns false.
+          This function returns true if the character is in the set, otherwise it returns false.
         
         
           True if ch is in the set, otherwise false.
@@ -46,7 +46,7 @@
           Return true if ch is in the character set.
         
         
-          This function returns true if the        character is in the set, otherwise        it returns false.
+          This function returns true if the character is in the set, otherwise it returns false.
         
         
           True if ch is in the set, otherwise false.
diff --git a/test-files/golden-tests/javadoc/copydoc/param-types.adoc b/test-files/golden-tests/javadoc/copydoc/param-types.adoc
index fcfd77cdf1..acc1dbcef4 100644
--- a/test-files/golden-tests/javadoc/copydoc/param-types.adoc
+++ b/test-files/golden-tests/javadoc/copydoc/param-types.adoc
@@ -162,7 +162,7 @@ f(<><4> a);
 === Description
 
 
-Documentation for a function with an        explicit object parameter.
+Documentation for a function with an explicit object parameter.
 
 This reference uses the `this` keyword.
 
@@ -201,7 +201,7 @@ g(this
 === Description
 
 
-Documentation for a function with an        explicit object parameter.
+Documentation for a function with an explicit object parameter.
 
 
 
@@ -431,7 +431,7 @@ f(<><0> a);
 
 Documentation for the reference function.
 
-This function uses a reference with no    parameters.
+This function uses a reference with no parameters.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/param-types.html b/test-files/golden-tests/javadoc/copydoc/param-types.html
index deb2a7e36f..40a2cd9cfe 100644
--- a/test-files/golden-tests/javadoc/copydoc/param-types.html
+++ b/test-files/golden-tests/javadoc/copydoc/param-types.html
@@ -19,8 +19,7 @@ 
    Namespaces
    
 
 
 
-N Namespace to test qualified identifier parameters.
-
+N Namespace to test qualified identifier parameters.
 
 
 
@@ -34,11 +33,9 @@ 
    Types
    
 
 
 
-A Struct to test explicit object member functions.
-
+A Struct to test explicit object member functions.
 
-paramType Struct used to vary the parameter type.
-
+paramType Struct used to vary the parameter type.
 
 
 
@@ -65,11 +62,9 @@ 
    Functions
    
 
 
 
-f f overloads
-
+f f overloads
 
-g g overloads
-
+g g overloads
 
 
 
@@ -78,8 +73,7 @@ 
    Functions
    
 
    
 
    N
    
 
    
-Namespace to test qualified identifier parameters.
-
+Namespace to test qualified identifier parameters.
 
 
    
 
    
@@ -93,8 +87,7 @@ 
    Namespaces
    
 
 
 
-M Namespace to test qualified identifier parameters.
-
+M Namespace to test qualified identifier parameters.
 
 
 
@@ -103,8 +96,7 @@ 
    Namespaces
    
 
    
 
    N::M
    
 
    
-Namespace to test qualified identifier parameters.
-
+Namespace to test qualified identifier parameters.
 
 
    
 
    
@@ -118,8 +110,7 @@ 
    Types
    
 
 
 
-Q Struct to test qualified identifier parameters.
-
+Q Struct to test qualified identifier parameters.
 
 
 
@@ -128,8 +119,7 @@ 
    Types
    
 
    
 
    N::M::Q
    
 
    
-Struct to test qualified identifier parameters.
-
+Struct to test qualified identifier parameters.
 
 
    
 
    
@@ -150,8 +140,7 @@ 
    Synopsis
    
 
    
 
    A
    
 
    
-Struct to test explicit object member functions.
-
+Struct to test explicit object member functions.
 
 
    
 
    
@@ -175,11 +164,9 @@ 
    Member Functions
    
 
 
 
-f Reference member function.
-
+f Reference member function.
 
-g Reference member function.
-
+g Reference member function.
 
 
 
@@ -190,8 +177,7 @@ 
    Member Functions
    
 
    
 
    A::f
    
 
    
-Reference member function.
-
+Reference member function.
 
 
    
 
    
@@ -208,10 +194,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with an        explicit object parameter.
    
-
    This reference uses the this keyword.
    
-
-
+
    Documentation for a function with an explicit object parameter.
    
+
    This reference uses the this keyword.
    
 
    
 
    
 
    Parameters
    
@@ -225,8 +209,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -236,8 +219,7 @@ 
    Parameters
    
 
    
 
    A::g
    
 
    
-Reference member function.
-
+Reference member function.
 
 
    
 
    
@@ -256,9 +238,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with an        explicit object parameter.
    
-
-
+
    Documentation for a function with an explicit object parameter.
    
 
    
 
    
 
    Parameters
    
@@ -272,13 +252,11 @@ 
    Parameters
    
 
 
 self
-
    The object to operate on
    
-
+The object to operate on
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -288,8 +266,7 @@ 
    Parameters
    
 
    
 
    paramType
    
 
    
-Struct used to vary the parameter type.
-
+Struct used to vary the parameter type.
 
 
    
 
    
@@ -339,8 +316,7 @@ 
    Members
    
 
    
 
    f
    
 
    
-f overloads
-
+f overloads
 
 
    
 
    
@@ -348,11 +324,7 @@ 
    f
    
 
    Synopses
    
 
    
 Declared in <param-types.cpp>
    
-
    
-    Reference function.
-
-
    
-
+
    Reference function.
    
 
 
     
@@ -361,11 +333,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function.
-
-
    
-
+
    Reference function.
    
 
 
     
@@ -374,11 +342,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function.
-
-
    
-
+
    Reference function.
    
 
 
     
@@ -387,11 +351,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Variadic function
-
-
    
-
+
    Variadic function
    
 
 
     
@@ -400,11 +360,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Non-variadic function
-
-
    
-
+
    Non-variadic function
    
 
 
     
@@ -413,11 +369,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    struct param function
-
-
    
-
+
    struct param function
    
 
 
     
@@ -426,11 +378,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Decltype function
-
-
    
-
+
    Decltype function
    
 
 
     
@@ -439,11 +387,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    struct param function
-
-
    
-
+
    struct param function
    
 
 
     
@@ -452,11 +396,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Enum param function
-
-
    
-
+
    Enum param function
    
 
 
     
@@ -465,11 +405,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Qualified identifier param function
-
-
    
-
+
    Qualified identifier param function
    
 
 
     
@@ -492,8 +428,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of f
    
-
+The first parameter of f
 
 
 
@@ -503,8 +438,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Reference function.
-
+Reference function.
 
 
    
 
    
@@ -521,17 +455,14 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function.
    
-
-
+
    Documentation for the reference function.
    
 
    
 
 
    
 
    
 
    f
    
 
    
-Reference function.
-
+Reference function.
 
 
    
 
    
@@ -548,10 +479,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function.
    
-
    This function uses a reference with no    parameters.
    
-
-
+
    Documentation for the reference function.
    
+
    This function uses a reference with no parameters.
    
 
    
 
    
 
    Parameters
    
@@ -565,8 +494,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of f
    
-
+The first parameter of f
 
 
 
@@ -576,8 +504,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Reference function.
-
+Reference function.
 
 
    
 
    
@@ -594,10 +521,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function.
    
-
    This reference uses the void keyword.
    
-
-
+
    Documentation for the reference function.
    
+
    This reference uses the void keyword.
    
 
    
 
    
 
    Parameters
    
@@ -611,8 +536,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of f
    
-
+The first parameter of f
 
 
 
@@ -622,8 +546,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Variadic function
-
+Variadic function
 
 
    
 
    
@@ -640,10 +563,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the variadic function.
    
-
    This reference uses the ... keyword.
    
-
-
+
    Documentation for the variadic function.
    
+
    This reference uses the ... keyword.
    
 
    
 
    
 
    Parameters
    
@@ -657,8 +578,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -668,8 +588,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Non-variadic function
-
+Non-variadic function
 
 
    
 
    
@@ -686,10 +605,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the non-variadic function.
    
-
    This reference uses the int keyword.
    
-
-
+
    Documentation for the non-variadic function.
    
+
    This reference uses the int keyword.
    
 
    
 
    
 
    Parameters
    
@@ -703,8 +620,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -714,8 +630,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-struct param function
-
+struct param function
 
 
    
 
    
@@ -732,10 +647,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a struct parameter.
    
-
    This reference uses the auto keyword.
    
-
-
+
    Documentation for a function with a struct parameter.
    
+
    This reference uses the auto keyword.
    
 
    
 
    
 
    Parameters
    
@@ -749,8 +662,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -760,8 +672,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Decltype function
-
+Decltype function
 
 
    
 
    
@@ -778,10 +689,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a decltype parameter.
    
-
    This reference uses the decltype keyword.
    
-
-
+
    Documentation for a function with a decltype parameter.
    
+
    This reference uses the decltype keyword.
    
 
    
 
    
 
    Parameters
    
@@ -795,8 +704,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -806,8 +714,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-struct param function
-
+struct param function
 
 
    
 
    
@@ -824,10 +731,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a struct parameter.
    
-
    This reference uses the struct keyword.
    
-
-
+
    Documentation for a function with a struct parameter.
    
+
    This reference uses the struct keyword.
    
 
    
 
    
 
    Parameters
    
@@ -841,8 +746,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -852,8 +756,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Enum param function
-
+Enum param function
 
 
    
 
    
@@ -870,10 +773,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with an enum parameter.
    
-
    This reference uses the enum keyword.
    
-
-
+
    Documentation for a function with an enum parameter.
    
+
    This reference uses the enum keyword.
    
 
    
 
    
 
    Parameters
    
@@ -887,8 +788,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -898,8 +798,7 @@ 
    Parameters
    
 
    
 
    f
    
 
    
-Qualified identifier param function
-
+Qualified identifier param function
 
 
    
 
    
@@ -916,10 +815,8 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a qualified identifier parameter.
    
-
    This reference uses the qualified identifier N::M::Q .
    
-
-
+
    Documentation for a function with a qualified identifier parameter.
    
+
    This reference uses the qualified identifier N::M::Q.
    
 
    
 
    
 
    Parameters
    
@@ -933,8 +830,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -944,8 +840,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-g overloads
-
+g overloads
 
 
    
 
    
@@ -953,11 +848,7 @@ 
    g
    
 
    Synopses
    
 
    
 Declared in <param-types.cpp>
    
-
    
-    struct param function
-
-
    
-
+
    struct param function
    
 
 
     
@@ -966,11 +857,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Qualified identifier param function
-
-
    
-
+
    Qualified identifier param function
    
 
 
     
@@ -979,11 +866,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Enum param function
-
-
    
-
+
    Enum param function
    
 
 
     
@@ -992,11 +875,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Variadic function
-
-
    
-
+
    Variadic function
    
 
 
     
@@ -1005,11 +884,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Non-variadic function
-
-
    
-
+
    Non-variadic function
    
 
 
     
@@ -1028,11 +903,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Decltype function
-
-
    
-
+
    Decltype function
    
 
 
     
@@ -1057,13 +928,11 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 b
-
    The second parameter of g
    
-
+The second parameter of g
 
 
 
@@ -1073,8 +942,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-struct param function
-
+struct param function
 
 
    
 
    
@@ -1091,9 +959,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a struct parameter.
    
-
-
+
    Documentation for a function with a struct parameter.
    
 
    
 
    
 
    Parameters
    
@@ -1107,8 +973,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -1118,8 +983,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-Qualified identifier param function
-
+Qualified identifier param function
 
 
    
 
    
@@ -1136,9 +1000,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a qualified identifier parameter.
    
-
-
+
    Documentation for a function with a qualified identifier parameter.
    
 
    
 
    
 
    Parameters
    
@@ -1152,8 +1014,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -1163,8 +1024,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-Enum param function
-
+Enum param function
 
 
    
 
    
@@ -1181,9 +1041,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with an enum parameter.
    
-
-
+
    Documentation for a function with an enum parameter.
    
 
    
 
    
 
    Parameters
    
@@ -1197,8 +1055,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -1208,8 +1065,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-Variadic function
-
+Variadic function
 
 
    
 
    
@@ -1226,9 +1082,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the variadic function.
    
-
-
+
    Documentation for the variadic function.
    
 
    
 
    
 
    Parameters
    
@@ -1242,8 +1096,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -1253,8 +1106,7 @@ 
    Parameters
    
 
    
 
    g
    
 
    
-Non-variadic function
-
+Non-variadic function
 
 
    
 
    
@@ -1271,9 +1123,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the non-variadic function.
    
-
-
+
    Documentation for the non-variadic function.
    
 
    
 
    
 
    Parameters
    
@@ -1287,8 +1137,7 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 
@@ -1315,8 +1164,7 @@ 
    Synopsis
    
 
    
 
    g
    
 
    
-Decltype function
-
+Decltype function
 
 
    
 
    
@@ -1335,9 +1183,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for a function with a decltype parameter.
    
-
-
+
    Documentation for a function with a decltype parameter.
    
 
    
 
    
 
    Parameters
    
@@ -1351,13 +1197,11 @@ 
    Parameters
    
 
 
 a
-
    The first parameter of g
    
-
+The first parameter of g
 
 
 b
-
    The second parameter of g
    
-
+The second parameter of g
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/param-types.xml b/test-files/golden-tests/javadoc/copydoc/param-types.xml
index 62ccc1f807..22caa9edc6 100644
--- a/test-files/golden-tests/javadoc/copydoc/param-types.xml
+++ b/test-files/golden-tests/javadoc/copydoc/param-types.xml
@@ -41,7 +41,7 @@
           Reference member function.
         
         
-          Documentation for a function with an        explicit object parameter.
+          Documentation for a function with an explicit object parameter.
         
         
           This reference uses the 
@@ -69,10 +69,10 @@
           Reference member function.
         
         
-          Documentation for a function with an        explicit object parameter.
+          Documentation for a function with an explicit object parameter.
         
         
-          The object to operate on        
+          The object to operate on
         
         
           The first parameter of g
@@ -118,7 +118,7 @@
         Documentation for the reference function.
       
       
-        This function uses a reference with no    parameters.
+        This function uses a reference with no parameters.
       
       
         The first parameter of f
@@ -233,7 +233,7 @@
          keyword.
       
       
-        The first parameter of g    
+        The first parameter of g
       
     
   
@@ -417,7 +417,7 @@
          parameter.
       
       
-        The first parameter of g    
+        The first parameter of g
       
       
         The second parameter of g
diff --git a/test-files/golden-tests/javadoc/copydoc/qualified.adoc b/test-files/golden-tests/javadoc/copydoc/qualified.adoc
index 9ec9bdabfe..c69e4cf013 100644
--- a/test-files/golden-tests/javadoc/copydoc/qualified.adoc
+++ b/test-files/golden-tests/javadoc/copydoc/qualified.adoc
@@ -589,7 +589,7 @@ g(int a);
 === Description
 
 
-Function with same number of parameters            but different types. This should fail.
+Function with same number of parameters but different types. This should fail.
 
 
 
@@ -703,7 +703,7 @@ h(int a);
 === Description
 
 
-Function with same number of parameters            but different types. This should fail.
+Function with same number of parameters but different types. This should fail.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/qualified.html b/test-files/golden-tests/javadoc/copydoc/qualified.html
index 7a0bc2edd2..7e0445421b 100644
--- a/test-files/golden-tests/javadoc/copydoc/qualified.html
+++ b/test-files/golden-tests/javadoc/copydoc/qualified.html
@@ -32,8 +32,7 @@ 
    Types
    
 
 
 
-param_t Helper class for distinct parameter types
-
+param_t Helper class for distinct parameter types
 
 
 
@@ -93,14 +92,11 @@ 
    Member Functions
    
 
 
 
-f Reference function
-
+f Reference function
 
-g g overloads
-
+g g overloads
 
-h h overloads
-
+h h overloads
 
 
 
@@ -128,8 +124,7 @@ 
    Synopsis
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -137,11 +132,7 @@ 
    N::A::f
    
 
    Synopses
    
 
    
 Declared in <qualified.cpp>
    
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -150,11 +141,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -163,11 +150,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -176,11 +159,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -189,11 +168,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -202,11 +177,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -215,11 +186,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -228,11 +195,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -255,8 +218,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -266,8 +228,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -284,9 +245,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -300,8 +259,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -311,8 +269,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -329,9 +286,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -345,8 +300,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -356,8 +310,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -374,9 +327,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -390,8 +341,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -401,8 +351,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -419,9 +368,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -435,8 +382,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -446,8 +392,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -464,9 +409,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -480,8 +423,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -491,8 +433,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -509,9 +450,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -525,8 +464,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -536,8 +474,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -554,9 +491,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -570,8 +505,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -581,8 +515,7 @@ 
    Parameters
    
 
    
 
    N::A::f
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -599,9 +532,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -615,8 +546,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -626,8 +556,7 @@ 
    Parameters
    
 
    
 
    N::A::g
    
 
    
-g overloads
-
+g overloads
 
 
    
 
    
@@ -635,11 +564,7 @@ 
    N::A::g
    
 
    Synopses
    
 
    
 Declared in <qualified.cpp>
    
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -648,11 +573,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Fail
-
-
    
-
+
    Fail
    
 
 
     
@@ -675,8 +596,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -686,8 +606,7 @@ 
    Parameters
    
 
    
 
    N::A::g
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -704,9 +623,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -720,8 +637,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -731,8 +647,7 @@ 
    Parameters
    
 
    
 
    N::A::g
    
 
    
-Fail
-
+Fail
 
 
    
 
    
@@ -749,9 +664,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Function with same number of parameters            but different types. This should fail.
    
-
-
+
    Function with same number of parameters but different types. This should fail.
    
 
    
 
    
 
    Parameters
    
@@ -765,8 +678,7 @@ 
    Parameters
    
 
 
 a
-
    Fundamental type parameter
    
-
+Fundamental type parameter
 
 
 
@@ -776,8 +688,7 @@ 
    Parameters
    
 
    
 
    N::A::h
    
 
    
-h overloads
-
+h overloads
 
 
    
 
    
@@ -785,11 +696,7 @@ 
    N::A::h
    
 
    Synopses
    
 
    
 Declared in <qualified.cpp>
    
-
    
-    Reference function
-
-
    
-
+
    Reference function
    
 
 
     
@@ -798,11 +705,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Fail
-
-
    
-
+
    Fail
    
 
 
     
@@ -825,8 +728,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -836,8 +738,7 @@ 
    Parameters
    
 
    
 
    N::A::h
    
 
    
-Reference function
-
+Reference function
 
 
    
 
    
@@ -854,9 +755,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Documentation for the reference function
    
-
-
+
    Documentation for the reference function
    
 
    
 
    
 
    Parameters
    
@@ -870,8 +769,7 @@ 
    Parameters
    
 
 
 a
-
    Qualified param
    
-
+Qualified param
 
 
 
@@ -881,8 +779,7 @@ 
    Parameters
    
 
    
 
    N::A::h
    
 
    
-Fail
-
+Fail
 
 
    
 
    
@@ -899,9 +796,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Function with same number of parameters            but different types. This should fail.
    
-
-
+
    Function with same number of parameters but different types. This should fail.
    
 
    
 
    
 
    Parameters
    
@@ -915,8 +810,7 @@ 
    Parameters
    
 
 
 a
-
    Fundamental type parameter
    
-
+Fundamental type parameter
 
 
 
@@ -926,8 +820,7 @@ 
    Parameters
    
 
    
 
    param_t
    
 
    
-Helper class for distinct parameter types
-
+Helper class for distinct parameter types
 
 
    
 
    
diff --git a/test-files/golden-tests/javadoc/copydoc/qualified.xml b/test-files/golden-tests/javadoc/copydoc/qualified.xml
index 45a6b6d9c6..3ab2d360a4 100644
--- a/test-files/golden-tests/javadoc/copydoc/qualified.xml
+++ b/test-files/golden-tests/javadoc/copydoc/qualified.xml
@@ -171,7 +171,7 @@
             Fail
           
           
-            Function with same number of parameters            but different types. This should fail.
+            Function with same number of parameters but different types. This should fail.
           
           
             Fundamental type parameter
@@ -205,7 +205,7 @@
             Fail
           
           
-            Function with same number of parameters            but different types. This should fail.
+            Function with same number of parameters but different types. This should fail.
           
           
             Fundamental type parameter
diff --git a/test-files/golden-tests/javadoc/copydoc/qualifiers.adoc b/test-files/golden-tests/javadoc/copydoc/qualifiers.adoc
index d082d0ce10..8739f02b40 100644
--- a/test-files/golden-tests/javadoc/copydoc/qualifiers.adoc
+++ b/test-files/golden-tests/javadoc/copydoc/qualifiers.adoc
@@ -159,7 +159,7 @@ begin();
 === Description
 
 
-Returns an iterator to the first element        of the vector.
+Returns an iterator to the first element of the vector.
 
 
 
@@ -188,7 +188,7 @@ begin() const;
 === Description
 
 
-Returns a const iterator to the first element        of the vector.
+Returns a const iterator to the first element of the vector.
 
 
 
@@ -217,7 +217,7 @@ cbegin() const;
 === Description
 
 
-Returns a const iterator to the first element        of the vector.
+Returns a const iterator to the first element of the vector.
 
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/qualifiers.html b/test-files/golden-tests/javadoc/copydoc/qualifiers.html
index 9a4d32330a..5a66cd08ab 100644
--- a/test-files/golden-tests/javadoc/copydoc/qualifiers.html
+++ b/test-files/golden-tests/javadoc/copydoc/qualifiers.html
@@ -62,20 +62,15 @@ 
    Member Functions
    
 
 
 
-begin begin overloads
-
+begin begin overloads
 
-cbegin Return a const iterator to the beginning
-
+cbegin Return a const iterator to the beginning
 
-crvalue An const rvalue reference to A
-
+crvalue An const rvalue reference to A
 
-ref ref overloads
-
+ref ref overloads
 
-rvalue An rvalue reference to A
-
+rvalue An rvalue reference to A
 
 
 
@@ -120,8 +115,7 @@ 
    Synopsis
    
 
    
 
    A::begin
    
 
    
-begin overloads
-
+begin overloads
 
 
    
 
    
@@ -129,11 +123,7 @@ 
    A::begin
    
 
    Synopses
    
 
    
 Declared in <qualifiers.cpp>
    
-
    
-    Returns an iterator to the beginning
-
-
    
-
+
    Returns an iterator to the beginning
    
 
 
     
@@ -142,11 +132,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Return a const iterator to the beginning
-
-
    
-
+
    Return a const iterator to the beginning
    
 
 
     
@@ -160,10 +146,8 @@ 
    Synopses
    
 
    
 
    Return Value
    
 
      
-
    • Iterator to the first element.
      
-
      • 
-
    • Const iterator to the first element.
      
-
      • 
+
    • Iterator to the first element.
      • 
+
    • Const iterator to the first element.
      • 
 
    
 
    
 
    
@@ -171,8 +155,7 @@ 
    Return Value
    
 
    
 
    A::begin
    
 
    
-Returns an iterator to the beginning
-
+Returns an iterator to the beginning
 
 
    
 
    
@@ -189,22 +172,18 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    Returns an iterator to the first element        of the vector.
    
-
-
+
    Returns an iterator to the first element of the vector.
    
 
    
 
    
 
    Return Value
    
-
    Iterator to the first element.
    
-
+Iterator to the first element.
 
    
 
 
    
 
    
 
    A::begin
    
 
    
-Return a const iterator to the beginning
-
+Return a const iterator to the beginning
 
 
    
 
    
@@ -221,22 +200,18 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Returns a const iterator to the first element        of the vector.
    
-
-
+
    Returns a const iterator to the first element of the vector.
    
 
    
 
    
 
    Return Value
    
-
    Const iterator to the first element.
    
-
+Const iterator to the first element.
 
    
 
 
    
 
    
 
    A::cbegin
    
 
    
-Return a const iterator to the beginning
-
+Return a const iterator to the beginning
 
 
    
 
    
@@ -253,22 +228,18 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Returns a const iterator to the first element        of the vector.
    
-
-
+
    Returns a const iterator to the first element of the vector.
    
 
    
 
    
 
    Return Value
    
-
    Const iterator to the first element.
    
-
+Const iterator to the first element.
 
    
 
 
    
 
    
 
    A::crvalue
    
 
    
-An const rvalue reference to A
-
+An const rvalue reference to A
 
 
    
 
    
@@ -285,16 +256,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
    
 
    
 
    A::ref
    
 
    
-ref overloads
-
+ref overloads
 
 
    
 
    
@@ -302,11 +271,7 @@ 
    A::ref
    
 
    Synopses
    
 
    
 Declared in <qualifiers.cpp>
    
-
    
-    An lvalue reference to A
-
-
    
-
+
    An lvalue reference to A
    
 
 
     
@@ -315,11 +280,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    An rvalue reference to A
-
-
    
-
+
    An rvalue reference to A
    
 
 
     
@@ -328,11 +289,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    An const lvalue reference to A
-
-
    
-
+
    An const lvalue reference to A
    
 
 
     
@@ -341,11 +298,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    An const rvalue reference to A
-
-
    
-
+
    An const rvalue reference to A
    
 
 
     
@@ -358,16 +311,14 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
    
 
    
 
    A::ref
    
 
    
-An lvalue reference to A
-
+An lvalue reference to A
 
 
    
 
    
@@ -384,16 +335,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
    
 
    
 
    A::ref
    
 
    
-An rvalue reference to A
-
+An rvalue reference to A
 
 
    
 
    
@@ -410,16 +359,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
    
 
    
 
    A::ref
    
 
    
-An const lvalue reference to A
-
+An const lvalue reference to A
 
 
    
 
    
@@ -436,16 +383,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
    
 
    
 
    A::ref
    
 
    
-An const rvalue reference to A
-
+An const rvalue reference to A
 
 
    
 
    
@@ -462,16 +407,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
    
 
    
 
    A::rvalue
    
 
    
-An rvalue reference to A
-
+An rvalue reference to A
 
 
    
 
    
@@ -488,8 +431,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    A reference to A
    
-
+A reference to A
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/copydoc/qualifiers.xml b/test-files/golden-tests/javadoc/copydoc/qualifiers.xml
index c7d71b32b0..9ff481e5a9 100644
--- a/test-files/golden-tests/javadoc/copydoc/qualifiers.xml
+++ b/test-files/golden-tests/javadoc/copydoc/qualifiers.xml
@@ -20,7 +20,7 @@
           Returns an iterator to the beginning
         
         
-          Returns an iterator to the first element        of the vector.
+          Returns an iterator to the first element of the vector.
         
         
           Iterator to the first element.
@@ -38,7 +38,7 @@
           Return a const iterator to the beginning
         
         
-          Returns a const iterator to the first element        of the vector.
+          Returns a const iterator to the first element of the vector.
         
         
           Const iterator to the first element.
@@ -56,7 +56,7 @@
           Return a const iterator to the beginning
         
         
-          Returns a const iterator to the first element        of the vector.
+          Returns a const iterator to the first element of the vector.
         
         
           Const iterator to the first element.
diff --git a/test-files/golden-tests/javadoc/copydoc/template-arguments.html b/test-files/golden-tests/javadoc/copydoc/template-arguments.html
index 8a2176b3b4..f89b64dd34 100644
--- a/test-files/golden-tests/javadoc/copydoc/template-arguments.html
+++ b/test-files/golden-tests/javadoc/copydoc/template-arguments.html
@@ -37,44 +37,31 @@ 
    Types
    
 
 
 
-B Main class template for B.
-
+B Main class template for B.
 
-B<int> Specialization of B for int.
-
+B<int> Specialization of B for int.
 
-B<int, 2> Specialization of B for int with value 2.
-
+B<int, 2> Specialization of B for int with value 2.
 
-C Main class template for C.
-
+C Main class template for C.
 
-C<D, true> Specialization of C for D with true.
-
+C<D, true> Specialization of C for D with true.
 
-C<int, true> Specialization of C for int with true.
-
+C<int, true> Specialization of C for int with true.
 
-D Helper struct D.
-
+D Helper struct D.
 
-BInt Specialization of B for int.
-
+BInt Specialization of B for int.
 
-BInt2 Specialization of B for int with value 2.
-
+BInt2 Specialization of B for int with value 2.
 
-B_t Main class template for B.
-
+B_t Main class template for B.
 
-CDTrue Specialization of C for D with true.
-
+CDTrue Specialization of C for D with true.
 
-CIntTrue Specialization of C for D with true.
-
+CIntTrue Specialization of C for D with true.
 
-C_t Main class template for C.
-
+C_t Main class template for C.
 
 
 
@@ -83,8 +70,7 @@ 
    Types
    
 
    
 
    A::BInt
    
 
    
-Specialization of B for int.
-
+Specialization of B for int.
 
 
    
 
    
@@ -103,8 +89,7 @@ 
    Synopsis
    
 
    
 
    A::BInt2
    
 
    
-Specialization of B for int with value 2.
-
+Specialization of B for int with value 2.
 
 
    
 
    
@@ -123,8 +108,7 @@ 
    Synopsis
    
 
    
 
    A::B_t
    
 
    
-Main class template for B.
-
+Main class template for B.
 
 
    
 
    
@@ -153,8 +137,7 @@ 
    Template Parameters
    
 
 
 T
-
    The type parameter.
    
-
+The type parameter.
 
 
 
@@ -164,8 +147,7 @@ 
    Template Parameters
    
 
    
 
    A::CDTrue
    
 
    
-Specialization of C for D with true.
-
+Specialization of C for D with true.
 
 
    
 
    
@@ -184,8 +166,7 @@ 
    Synopsis
    
 
    
 
    A::CIntTrue
    
 
    
-Specialization of C for D with true.
-
+Specialization of C for D with true.
 
 
    
 
    
@@ -204,8 +185,7 @@ 
    Synopsis
    
 
    
 
    A::C_t
    
 
    
-Main class template for C.
-
+Main class template for C.
 
 
    
 
    
@@ -234,8 +214,7 @@ 
    Template Parameters
    
 
 
 T
-
    The type parameter.
    
-
+The type parameter.
 
 
 
@@ -245,8 +224,7 @@ 
    Template Parameters
    
 
    
 
    A::B
    
 
    
-Main class template for B.
-
+Main class template for B.
 
 
    
 
    
@@ -277,13 +255,11 @@ 
    Template Parameters
    
 
 
 T
-
    The type parameter.
    
-
+The type parameter.
 
 
 int
-
    The integer parameter with a default value of 0.
    
-
+The integer parameter with a default value of 0.
 
 
 
@@ -293,8 +269,7 @@ 
    Template Parameters
    
 
    
 
    A::B<int>
    
 
    
-Specialization of B for int.
-
+Specialization of B for int.
 
 
    
 
    
@@ -316,8 +291,7 @@ 
    Synopsis
    
 
    
 
    A::B<int, 2>
    
 
    
-Specialization of B for int with value 2.
-
+Specialization of B for int with value 2.
 
 
    
 
    
@@ -339,8 +313,7 @@ 
    Synopsis
    
 
    
 
    A::C
    
 
    
-Main class template for C.
-
+Main class template for C.
 
 
    
 
    
@@ -371,13 +344,11 @@ 
    Template Parameters
    
 
 
 T
-
    The type parameter.
    
-
+The type parameter.
 
 
 bool
-
    The boolean parameter with a default value of false.
    
-
+The boolean parameter with a default value of false.
 
 
 
@@ -387,8 +358,7 @@ 
    Template Parameters
    
 
    
 
    A::C<D, true>
    
 
    
-Specialization of C for D with true.
-
+Specialization of C for D with true.
 
 
    
 
    
@@ -410,8 +380,7 @@ 
    Synopsis
    
 
    
 
    A::C<int, true>
    
 
    
-Specialization of C for int with true.
-
+Specialization of C for int with true.
 
 
    
 
    
@@ -433,8 +402,7 @@ 
    Synopsis
    
 
    
 
    A::D
    
 
    
-Helper struct D.
-
+Helper struct D.
 
 
    
 
    
diff --git a/test-files/golden-tests/javadoc/copydoc/template-arguments.xml b/test-files/golden-tests/javadoc/copydoc/template-arguments.xml
index 8b092f6666..2acc34ca10 100644
--- a/test-files/golden-tests/javadoc/copydoc/template-arguments.xml
+++ b/test-files/golden-tests/javadoc/copydoc/template-arguments.xml
@@ -32,7 +32,7 @@
             Main class template for B.
           
           
-            The type parameter.         
+            The type parameter.
           
         
       
@@ -66,7 +66,7 @@
             Main class template for C.
           
           
-            The type parameter.         
+            The type parameter.
           
         
       
@@ -81,7 +81,7 @@
             Main class template for B.
           
           
-            The type parameter.         
+            The type parameter.
           
           
             The integer parameter with a default value of 0.
@@ -122,7 +122,7 @@
             Main class template for C.
           
           
-            The type parameter.         
+            The type parameter.
           
           
             The boolean parameter with a default value of false.
diff --git a/test-files/golden-tests/javadoc/inline/styled.adoc b/test-files/golden-tests/javadoc/inline/styled.adoc
index 9ed165fbb7..aaf1522b8b 100644
--- a/test-files/golden-tests/javadoc/inline/styled.adoc
+++ b/test-files/golden-tests/javadoc/inline/styled.adoc
@@ -76,7 +76,7 @@ compare(<> const& other) const noexcept;
 === Return Value
 
 
-`‐1` if `*this < other`, `0` if        `this == other`, and 1 if `this > other`.
+`‐1` if `*this < other`, `0` if `this == other`, and 1 if `this > other`.
 
 === Parameters
 
diff --git a/test-files/golden-tests/javadoc/inline/styled.html b/test-files/golden-tests/javadoc/inline/styled.html
index 87c88e0610..4457cef547 100644
--- a/test-files/golden-tests/javadoc/inline/styled.html
+++ b/test-files/golden-tests/javadoc/inline/styled.html
@@ -19,8 +19,7 @@ 
    Types
    
 
 
 
-A Brief for A
-
+A Brief for A
 
 
 
@@ -29,8 +28,7 @@ 
    Types
    
 
    
 
    A
    
 
    
-Brief for A
-
+Brief for A
 
 
    
 
    
@@ -54,8 +52,7 @@ 
    Member Functions
    
 
 
 
-compare Compare function
-
+compare Compare function
 
 
 
@@ -63,18 +60,15 @@ 
    Member Functions
    
 
 
    
 
    Description
    
-
    Paragraph with code , bold text, and italic text.
    
-
    We can also escape these markers: `, *, and _.
    
-
-
+
    Paragraph with code, bold text, and italic text.
    
+
    We can also escape these markers: `, *, and _.
    
 
    
 
 
    
 
    
 
    A::compare
    
 
    
-Compare function
-
+Compare function
 
 
    
 
    
@@ -91,8 +85,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    -1 if *this < other , 0 if        this == other , and 1 if this > other .
    
-
+-1 if *this < other, 0 if this == other, and 1 if this > other.
 
    
 
    
 
    Parameters
    
@@ -106,8 +99,7 @@ 
    Parameters
    
 
 
 other
-
    The other object to compare against.
    
-
+The other object to compare against.
 
 
 
diff --git a/test-files/golden-tests/javadoc/inline/styled.xml b/test-files/golden-tests/javadoc/inline/styled.xml
index 50f72ec1d4..5f23101818 100644
--- a/test-files/golden-tests/javadoc/inline/styled.xml
+++ b/test-files/golden-tests/javadoc/inline/styled.xml
@@ -42,7 +42,7 @@
           *this < other
           , 
           0
-           if        
+           if 
           this == other
           , and 1 if 
           this > other
diff --git a/test-files/golden-tests/javadoc/link/link.adoc b/test-files/golden-tests/javadoc/link/link.adoc
new file mode 100644
index 0000000000..6ffb5fba99
--- /dev/null
+++ b/test-files/golden-tests/javadoc/link/link.adoc
@@ -0,0 +1,46 @@
+= Reference
+:mrdocs:
+
+[#index]
+== Global namespace
+
+
+=== Functions
+
+[cols=2]
+|===
+| Name 
+| Description 
+
+| <> 
+| A function with a link
+
+|===
+
+[#f]
+== f
+
+
+A function with a link
+
+=== Synopsis
+
+
+Declared in `<link.cpp>`
+
+[source,cpp,subs="verbatim,replacements,macros,-callouts"]
+----
+void
+f();
+----
+
+=== Description
+
+
+This is a function with a link to https://www.boost.org[].
+
+
+
+
+
+[.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/javadoc/link/link.cpp b/test-files/golden-tests/javadoc/link/link.cpp
new file mode 100644
index 0000000000..e850ef9290
--- /dev/null
+++ b/test-files/golden-tests/javadoc/link/link.cpp
@@ -0,0 +1,7 @@
+/** @brief A function with a link
+
+    This is a function with a link to
+    Boost.
+
+ */
+void f();
diff --git a/test-files/golden-tests/javadoc/link/link.html b/test-files/golden-tests/javadoc/link/link.html
new file mode 100644
index 0000000000..d616295a4d
--- /dev/null
+++ b/test-files/golden-tests/javadoc/link/link.html
@@ -0,0 +1,57 @@
+
+
+Reference
+
+
+
    
+
    Reference
    
+
    
+
    
+
    Global namespace
    
+
    
+
    Functions
    
+
+
+
+
+
+
+
+
+
+
+
+
+
    NameDescription
    f A function with a link
    
+
    
+
    
+
    
+
    f
    
+
    
+A function with a link
+
+
    
+
    
+
    
+
    Synopsis
    
+
    
+Declared in <link.cpp>
    
+
    +
+void
+f();
+
+
    
+
    
+
    
+
    Description
    
+
    This is a function with a link to .
    
+
    
+
    
+
+
    
+
    
+
    Created with MrDocs
    
+
    
+
+
\ No newline at end of file
diff --git a/test-files/golden-tests/javadoc/link/link.xml b/test-files/golden-tests/javadoc/link/link.xml
new file mode 100644
index 0000000000..79a6e1a2f6
--- /dev/null
+++ b/test-files/golden-tests/javadoc/link/link.xml
@@ -0,0 +1,19 @@
+
+
+
+  
+    
+    
+      
+        A function with a link
+      
+      
+        This is a function with a link to 
+        Boost
+        .
+      
+    
+  
+
+
diff --git a/test-files/golden-tests/javadoc/lists/li.adoc b/test-files/golden-tests/javadoc/lists/li.adoc
index b8f55a4cdc..9810f3b009 100644
--- a/test-files/golden-tests/javadoc/lists/li.adoc
+++ b/test-files/golden-tests/javadoc/lists/li.adoc
@@ -39,7 +39,7 @@ f();
 
 Description:
 
-* Point 1 
+* Point 1
 * Point 2
 
 Another paragraph.
diff --git a/test-files/golden-tests/javadoc/lists/li.html b/test-files/golden-tests/javadoc/lists/li.html
index 6cc5d13b39..0fac5a5253 100644
--- a/test-files/golden-tests/javadoc/lists/li.html
+++ b/test-files/golden-tests/javadoc/lists/li.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f A function
-
+f A function
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-A function
-
+A function
 
 
    
 
    
@@ -47,14 +45,12 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    Description:
    
+
    Description:
    
 
      
-
    • Point 1 
      • 
+
    • Point 1
      • 
 
    • Point 2
      • 
 
    
-
    Another paragraph.
    
-
-
+
    Another paragraph.
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/lists/li.xml b/test-files/golden-tests/javadoc/lists/li.xml
index 8fe930f201..4982ddb379 100644
--- a/test-files/golden-tests/javadoc/lists/li.xml
+++ b/test-files/golden-tests/javadoc/lists/li.xml
@@ -6,14 +6,14 @@
     
     
       
-        A function 
+        A function
       
       
    
         Description:
       
    
       
         
-          Point 1 
+          Point 1
         
         
           Point 2
diff --git a/test-files/golden-tests/javadoc/lists/listitem.adoc b/test-files/golden-tests/javadoc/lists/listitem.adoc
index 987aa944e0..28a7d899ed 100644
--- a/test-files/golden-tests/javadoc/lists/listitem.adoc
+++ b/test-files/golden-tests/javadoc/lists/listitem.adoc
@@ -66,7 +66,7 @@ f1();
 === Description
 
 
-* item 1    
+* item 1
 * item 2
 
 
@@ -91,7 +91,7 @@ f2();
 === Description
 
 
-* item 1    
+* item 1
 * item 2
 
 
diff --git a/test-files/golden-tests/javadoc/lists/listitem.html b/test-files/golden-tests/javadoc/lists/listitem.html
index 4dba1d6b33..d1ac2221d8 100644
--- a/test-files/golden-tests/javadoc/lists/listitem.html
+++ b/test-files/golden-tests/javadoc/lists/listitem.html
@@ -19,15 +19,13 @@ 
    Functions
    
 
 
 
-f0 
+f0 
 
-f1 
+f1 
 
-f2 brief
-
+f2 brief
 
-f3 brief
-
+f3 brief
 
 
 
@@ -52,8 +50,6 @@ 
    Description
    
 
      
 
    • item
      • 
 
    
-
-
 
 
 
    
@@ -74,19 +70,16 @@ 
    Synopsis
    
 
    
 
    Description
    
 
      
-
    • item 1    
      • 
+
    • item 1
      • 
 
    • item 2
      • 
 
    
-
-
 
    
 
    
 
    
 
    
 
    f2
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -104,19 +97,16 @@ 
    Synopsis
    
 
    
 
    Description
    
 
      
-
    • item 1    
      • 
+
    • item 1
      • 
 
    • item 2
      • 
 
    
-
-
 
    
 
    
 
    
 
    
 
    f3
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -138,8 +128,6 @@ 
    Description
    
 
  • item 2
    • 
 
  • item 3
    • 
 
-
-
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/lists/listitem.xml b/test-files/golden-tests/javadoc/lists/listitem.xml
index 83c819da69..6f7aed798f 100644
--- a/test-files/golden-tests/javadoc/lists/listitem.xml
+++ b/test-files/golden-tests/javadoc/lists/listitem.xml
@@ -17,7 +17,7 @@
     
       
         
-          item 1    
+          item 1
         
         
           item 2
@@ -33,7 +33,7 @@
       
       
         
-          item 1    
+          item 1
         
         
           item 2
diff --git a/test-files/golden-tests/javadoc/paragraph/par-1.html b/test-files/golden-tests/javadoc/paragraph/par-1.html
index 95dae7c08d..a3e27754d4 100644
--- a/test-files/golden-tests/javadoc/paragraph/par-1.html
+++ b/test-files/golden-tests/javadoc/paragraph/par-1.html
@@ -19,17 +19,13 @@ 
    Functions
    
 
 
 
-f1 Brief
-
+f1 Brief
 
-f2 Brief
-
+f2 Brief
 
-f3 Brief
-
+f3 Brief
 
-f4 Brief
-
+f4 Brief
 
 
 
@@ -38,8 +34,7 @@ 
    Functions
    
 
    
 
    f1
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -57,20 +52,17 @@ 
    Synopsis
    
 
    
 
    Description
    
 
    Custom par
    
-
    Paragraph 1
    
+
    Paragraph 1
    
 
 void f1();
 
-
-
 
    
 
 
    
 
    
 
    f2
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -88,20 +80,17 @@ 
    Synopsis
    
 
    
 
    Description
    
 
    Custom par
    
-
    Paragraph 2
    
+
    Paragraph 2
    
 
 void f2();
 
-
-
 
    
 
    
 
    
 
    
 
    f3
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -122,16 +111,13 @@ 
    Custom par
    
 
 void f3();
 
-
-
 
    
 
 
    
 
    
 
    f4
    
 
    
-Brief
-
+Brief
 
 
    
 
    
@@ -152,8 +138,6 @@ 
    Custom par
    
 
 void f4();
 
-
-
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/paragraph/par-1.xml b/test-files/golden-tests/javadoc/paragraph/par-1.xml
index 487eed99a3..4d6e662db8 100644
--- a/test-files/golden-tests/javadoc/paragraph/par-1.xml
+++ b/test-files/golden-tests/javadoc/paragraph/par-1.xml
@@ -13,7 +13,7 @@
         Paragraph 1
       
       
-            void f1();
+        void f1();
       
         
   
@@ -28,7 +28,7 @@
         Paragraph 2
       
       
-            void f2();
+        void f2();
       
         
   
@@ -40,7 +40,7 @@
       
       Custom par
       
-            void f3();
+        void f3();
       
     
   
@@ -52,7 +52,7 @@
       
       Custom par
       
-            void f4();
+        void f4();
       
     
   
diff --git a/test-files/golden-tests/javadoc/paragraph/para-1.html b/test-files/golden-tests/javadoc/paragraph/para-1.html
index 3d6b37328b..c981a94987 100644
--- a/test-files/golden-tests/javadoc/paragraph/para-1.html
+++ b/test-files/golden-tests/javadoc/paragraph/para-1.html
@@ -19,14 +19,13 @@ 
    Functions
    
 
 
 
-f1 
+f1 
 
-f2 
+f2 
 
-f3 
+f3 
 
-f4 brief
-
+f4 brief
 
 
 
@@ -83,8 +82,7 @@ 
    Synopsis
    
 
    
 
    f4
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -101,11 +99,9 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    a
    
-
    b
    
-
    c
    
-
-
+
    a
    
+
    b
    
+
    c
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/paragraph/para-2.adoc b/test-files/golden-tests/javadoc/paragraph/para-2.adoc
index 94f6757e94..5aae2c08ac 100644
--- a/test-files/golden-tests/javadoc/paragraph/para-2.adoc
+++ b/test-files/golden-tests/javadoc/paragraph/para-2.adoc
@@ -37,7 +37,7 @@ f1();
 === Description
 
 
-a b  c   d
+a b c d
 
 
 
diff --git a/test-files/golden-tests/javadoc/paragraph/para-2.html b/test-files/golden-tests/javadoc/paragraph/para-2.html
index 7960567bbb..ede07650bf 100644
--- a/test-files/golden-tests/javadoc/paragraph/para-2.html
+++ b/test-files/golden-tests/javadoc/paragraph/para-2.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f1 brief
-
+f1 brief
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f1
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -47,9 +45,7 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    a b  c   d
    
-
-
+
    a b c d
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/paragraph/para-2.xml b/test-files/golden-tests/javadoc/paragraph/para-2.xml
index 8ab713d116..796951217c 100644
--- a/test-files/golden-tests/javadoc/paragraph/para-2.xml
+++ b/test-files/golden-tests/javadoc/paragraph/para-2.xml
@@ -9,7 +9,7 @@
         brief
       
       
-        a b  c   d
+        a b c d
       
     
   
diff --git a/test-files/golden-tests/javadoc/paragraph/para-3.html b/test-files/golden-tests/javadoc/paragraph/para-3.html
index 808f5dbaad..e8df9b6e03 100644
--- a/test-files/golden-tests/javadoc/paragraph/para-3.html
+++ b/test-files/golden-tests/javadoc/paragraph/para-3.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-my_function A function
-
+my_function A function
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    my_function
    
 
    
-A function
-
+A function
 
 
    
 
    
@@ -48,12 +46,10 @@ 
    Synopsis
    
 
    
 
    Description
    
 
    A heading. Some text.
    
-
    More text...
    
-
    Another paragraph Next line
    
+
    More text...
    
+
    Another paragraph Next line
    
 
    Exception safety
    
-
    No-throw guarantee.
    
-
-
+
    No-throw guarantee.
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/param/param-1.html b/test-files/golden-tests/javadoc/param/param-1.html
index 28a58c4541..f11f64e8c1 100644
--- a/test-files/golden-tests/javadoc/param/param-1.html
+++ b/test-files/golden-tests/javadoc/param/param-1.html
@@ -19,15 +19,15 @@ 
    Functions
    
 
 
 
-f0 
+f0 
 
-f1 
+f1 
 
-f2 
+f2 
 
-f3 
+f3 
 
-f4 
+f4 
 
 
 
@@ -59,8 +59,7 @@ 
    Parameters
    
 
 
 i
-
    int
    
-
+int
 
 
 
@@ -93,8 +92,7 @@ 
    Parameters
    
 
 
 i [in]
-
    int
    
-
+int
 
 
 
@@ -127,8 +125,7 @@ 
    Parameters
    
 
 
 i [out]
-
    int
    
-
+int
 
 
 
@@ -161,8 +158,7 @@ 
    Parameters
    
 
 
 i [inout]
-
    int
    
-
+int
 
 
 
@@ -197,8 +193,7 @@ 
    Parameters
    
 
 
 i,j
-
    numbers
    
-
+numbers
 
 
 
diff --git a/test-files/golden-tests/javadoc/param/param-direction.html b/test-files/golden-tests/javadoc/param/param-direction.html
index 13351d1744..916cabcb6c 100644
--- a/test-files/golden-tests/javadoc/param/param-direction.html
+++ b/test-files/golden-tests/javadoc/param/param-direction.html
@@ -19,25 +19,25 @@ 
    Functions
    
 
 
 
-f 
+f 
 
-g 
+g 
 
-h 
+h 
 
-i 
+i 
 
-j 
+j 
 
-k 
+k 
 
-l 
+l 
 
-m 
+m 
 
-n 
+n 
 
-o 
+o 
 
 
 
@@ -69,7 +69,7 @@ 
    Parameters
    
 
 
 x0
-
+
 
 
 
@@ -104,11 +104,11 @@ 
    Parameters
    
 
 
 x1
-
+
 
 
 y1 [in]
-
+
 
 
 
@@ -143,11 +143,11 @@ 
    Parameters
    
 
 
 x2
-
+
 
 
 y2 [out]
-
+
 
 
 
@@ -182,11 +182,11 @@ 
    Parameters
    
 
 
 x3 [in]
-
+
 
 
 y3 [out]
-
+
 
 
 
@@ -221,11 +221,11 @@ 
    Parameters
    
 
 
 x4
-
+
 
 
 y4 [inout]
-
+
 
 
 
@@ -261,15 +261,15 @@ 
    Parameters
    
 
 
 x5 [out]
-
+
 
 
 y5 [in]
-
+
 
 
 z5
-
+
 
 
 
@@ -306,15 +306,15 @@ 
    Parameters
    
 
 
 x6 [out]
-
+
 
 
 y6
-
+
 
 
 z6 [in]
-
+
 
 
 
@@ -349,11 +349,11 @@ 
    Parameters
    
 
 
 x7 [in]
-
+
 
 
 y7 [out]
-
+
 
 
 
@@ -386,7 +386,7 @@ 
    Parameters
    
 
 
 x8 [in]
-
+
 
 
 
@@ -419,11 +419,11 @@ 
    Parameters
    
 
 
 x9 [in]
-
+
 
 
 x9 [out]
-
+
 
 
 
diff --git a/test-files/golden-tests/javadoc/param/param-duplicate.html b/test-files/golden-tests/javadoc/param/param-duplicate.html
index b3e75f7c94..6c3107fef6 100644
--- a/test-files/golden-tests/javadoc/param/param-duplicate.html
+++ b/test-files/golden-tests/javadoc/param/param-duplicate.html
@@ -19,23 +19,17 @@ 
    Functions
    
 
 
 
-f0 f0 brief
-
+f0 f0 brief
 
-f1 f1 brief
-
+f1 f1 brief
 
-g0 g0 brief
-
+g0 g0 brief
 
-g1 g1 brief
-
+g1 g1 brief
 
-h0 h0 brief
-
+h0 h0 brief
 
-h1 h1 brief
-
+h1 h1 brief
 
 
 
@@ -44,8 +38,7 @@ 
    Functions
    
 
    
 
    f0
    
 
    
-f0 brief
-
+f0 brief
 
 
    
 
    
@@ -63,10 +56,8 @@ 
    Synopsis
    
 
    
 
    Return Value
    
 
      
-
    • int
      
-
      • 
-
    • int
      
-
      • 
+
    • int
      • 
+
    • int
      • 
 
    
 
    
 
@@ -74,8 +65,7 @@ 
    Return Value
    
 
    
 
    f1
    
 
    
-f1 brief
-
+f1 brief
 
 
    
 
    
@@ -93,10 +83,8 @@ 
    Synopsis
    
 
    
 
    Return Value
    
 
      
-
    • int
      
-
      • 
-
    • bool
      
-
      • 
+
    • int
      • 
+
    • bool
      • 
 
    
 
    
 
@@ -104,8 +92,7 @@ 
    Return Value
    
 
    
 
    g0
    
 
    
-g0 brief
-
+g0 brief
 
 
    
 
    
@@ -132,13 +119,11 @@ 
    Parameters
    
 
 
 a
-
    one
    
-
+one
 
 
 a
-
    one
    
-
+one
 
 
 
@@ -148,8 +133,7 @@ 
    Parameters
    
 
    
 
    g1
    
 
    
-g1 brief
-
+g1 brief
 
 
    
 
    
@@ -176,13 +160,11 @@ 
    Parameters
    
 
 
 a
-
    one
    
-
+one
 
 
 b
-
    two
    
-
+two
 
 
 
@@ -192,8 +174,7 @@ 
    Parameters
    
 
    
 
    h0
    
 
    
-h0 brief
-
+h0 brief
 
 
    
 
    
@@ -221,13 +202,11 @@ 
    Template Parameters
    
 
 
 T
-
    one
    
-
+one
 
 
 T
-
    one
    
-
+one
 
 
 
@@ -237,8 +216,7 @@ 
    Template Parameters
    
 
    
 
    h1
    
 
    
-h1 brief
-
+h1 brief
 
 
    
 
    
@@ -266,13 +244,11 @@ 
    Template Parameters
    
 
 
 T
-
    one
    
-
+one
 
 
 U
-
    two
    
-
+two
 
 
 
diff --git a/test-files/golden-tests/javadoc/param/param-duplicate.xml b/test-files/golden-tests/javadoc/param/param-duplicate.xml
index cc21e18d5d..904225e768 100644
--- a/test-files/golden-tests/javadoc/param/param-duplicate.xml
+++ b/test-files/golden-tests/javadoc/param/param-duplicate.xml
@@ -46,7 +46,7 @@
         g0 brief
       
       
-        one    
+        one
       
       
         one
@@ -63,7 +63,7 @@
         g1 brief
       
       
-        one    
+        one
       
       
         two
@@ -79,7 +79,7 @@
           h0 brief
         
         
-          one    
+          one
         
         
           one
@@ -96,7 +96,7 @@
           h1 brief
         
         
-          one    
+          one
         
         
           two
diff --git a/test-files/golden-tests/javadoc/param/param.html b/test-files/golden-tests/javadoc/param/param.html
index ed35659358..450b03ac76 100644
--- a/test-files/golden-tests/javadoc/param/param.html
+++ b/test-files/golden-tests/javadoc/param/param.html
@@ -19,13 +19,13 @@ 
    Functions
    
 
 
 
-f 
+f 
 
-g 
+g 
 
-h 
+h 
 
-i 
+i 
 
 
 
@@ -57,7 +57,7 @@ 
    Parameters
    
 
 
 x
-
+
 
 
 
@@ -92,11 +92,11 @@ 
    Parameters
    
 
 
 x
-
+
 
 
 y
-
+
 
 
 
@@ -132,15 +132,15 @@ 
    Parameters
    
 
 
 x
-
+
 
 
 y
-
+
 
 
 z
-
+
 
 
 
@@ -177,19 +177,19 @@ 
    Parameters
    
 
 
 w
-
+
 
 
 x
-
+
 
 
 y
-
+
 
 
 z
-
+
 
 
 
diff --git a/test-files/golden-tests/javadoc/pre/pre-post.adoc b/test-files/golden-tests/javadoc/pre/pre-post.adoc
index 92bfe822b2..2439db9820 100644
--- a/test-files/golden-tests/javadoc/pre/pre-post.adoc
+++ b/test-files/golden-tests/javadoc/pre/pre-post.adoc
@@ -36,8 +36,6 @@ f();
 
 
 * first precondition
-
-
 * second precondition
 
 
diff --git a/test-files/golden-tests/javadoc/pre/pre-post.html b/test-files/golden-tests/javadoc/pre/pre-post.html
index acf3041998..529f2e5250 100644
--- a/test-files/golden-tests/javadoc/pre/pre-post.html
+++ b/test-files/golden-tests/javadoc/pre/pre-post.html
@@ -19,7 +19,7 @@ 
    Functions
    
 
 
 
-f 
+f 
 
 
 
@@ -42,17 +42,14 @@ 
    Synopsis
    
 
    
 
    Preconditions
    
 
      
-
    • first precondition
      
-
      • 
-
    • second precondition
      
-
      • 
+
    • first precondition
      • 
+
    • second precondition
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • first postcondition
      
-
      • 
+
    • first postcondition
      • 
 
    
 
    
 
diff --git a/test-files/golden-tests/javadoc/pre/pre-post.xml b/test-files/golden-tests/javadoc/pre/pre-post.xml
index fc750f9a60..9ad37056f3 100644
--- a/test-files/golden-tests/javadoc/pre/pre-post.xml
+++ b/test-files/golden-tests/javadoc/pre/pre-post.xml
@@ -6,7 +6,7 @@
     
     
       
    -        first precondition    
+        first precondition
       
    
       
             second precondition
diff --git a/test-files/golden-tests/javadoc/ref/broken-ref.adoc b/test-files/golden-tests/javadoc/ref/broken-ref.adoc
index 4ccc283582..41380f09bb 100644
--- a/test-files/golden-tests/javadoc/ref/broken-ref.adoc
+++ b/test-files/golden-tests/javadoc/ref/broken-ref.adoc
@@ -16,7 +16,7 @@
 | 
 
 | <> 
-| See xref:#f0[f0]
+| See <>
 
 |===
 
@@ -39,7 +39,7 @@ f0();
 == f1
 
 
-See xref:#f0[f0]
+See <>
 
 === Synopsis
 
@@ -55,11 +55,11 @@ f1();
 === Description
 
 
-See ::f2
+See `::f2`
 
 Broken should be warned only once
 
-See ::f2
+See `::f2`
 
 
 
diff --git a/test-files/golden-tests/javadoc/ref/broken-ref.html b/test-files/golden-tests/javadoc/ref/broken-ref.html
index e010d75e06..9c4dd358bd 100644
--- a/test-files/golden-tests/javadoc/ref/broken-ref.html
+++ b/test-files/golden-tests/javadoc/ref/broken-ref.html
@@ -19,10 +19,9 @@ 
    Functions
    
 
 
 
-f0 
+f0 
 
-f1 See f0
-
+f1 See f0
 
 
 
@@ -47,8 +46,7 @@ 
    Synopsis
    
 
    
 
    f1
    
 
    
-See f0
-
+See f0
 
 
    
 
    
@@ -65,11 +63,9 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    See ::f2
    
-
    Broken should be warned only once
    
-
    See ::f2
    
-
-
+
    See ::f2
    
+
    Broken should be warned only once
    
+
    See ::f2
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/ref/punctuation.adoc b/test-files/golden-tests/javadoc/ref/punctuation.adoc
index 421c60b5e2..98df2ee69f 100644
--- a/test-files/golden-tests/javadoc/ref/punctuation.adoc
+++ b/test-files/golden-tests/javadoc/ref/punctuation.adoc
@@ -19,7 +19,7 @@
 | 
 
 | <> 
-| See xref:#f0[f0], xref:#f1[f1].
+| See <>, <>.
 
 |===
 
@@ -57,7 +57,7 @@ f1();
 == f2
 
 
-See xref:#f0[f0], xref:#f1[f1].
+See <>, <>.
 
 === Synopsis
 
diff --git a/test-files/golden-tests/javadoc/ref/punctuation.html b/test-files/golden-tests/javadoc/ref/punctuation.html
index 114387e111..19cc232af2 100644
--- a/test-files/golden-tests/javadoc/ref/punctuation.html
+++ b/test-files/golden-tests/javadoc/ref/punctuation.html
@@ -19,12 +19,11 @@ 
    Functions
    
 
 
 
-f0 
+f0 
 
-f1 
+f1 
 
-f2 See f0 , f1 .
-
+f2 See f0, f1.
 
 
 
@@ -65,8 +64,7 @@ 
    Synopsis
    
 
    
 
    f2
    
 
    
-See f0 , f1 .
-
+See f0, f1.
 
 
    
 
    
diff --git a/test-files/golden-tests/javadoc/ref/ref.adoc b/test-files/golden-tests/javadoc/ref/ref.adoc
index 2df0d98759..1d0eb79f82 100644
--- a/test-files/golden-tests/javadoc/ref/ref.adoc
+++ b/test-files/golden-tests/javadoc/ref/ref.adoc
@@ -34,10 +34,10 @@
 | 
 
 | <> 
-| See xref:#A-f1[A::f1]
+| See <>
 
 | <> 
-| See xref:#F-operator_bitnot[F::operator~]
+| See <>
 
 |===
 
@@ -53,7 +53,7 @@
 | Description 
 
 | <> 
-| See xref:#A-f1[f1]
+| See <>
 
 | <> 
 | 
@@ -70,7 +70,7 @@
 | Description 
 
 | <> 
-| See xref:#f0[f0]
+| See <>
 
 |===
 
@@ -78,7 +78,7 @@
 == <>::B
 
 
-See xref:#A-f1[f1]
+See <>
 
 === Synopsis
 
@@ -106,9 +106,9 @@ struct B;
 === Description
 
 
-See xref:#A-f1[A::f1]
+See <>
 
-See xref:#A-f1[::A::f1]
+See <>
 
 
 
@@ -208,7 +208,7 @@ struct D
 | Description 
 
 | <> 
-| See xref:#A-C-f3[f3]
+| See <>
 
 |===
 === Member Functions
@@ -229,7 +229,7 @@ struct D
 == <>::<>::E
 
 
-See xref:#A-C-f3[f3]
+See <>
 
 === Synopsis
 
@@ -247,9 +247,9 @@ struct E;
 === Description
 
 
-See xref:#A-D-f4[f4]
+See <>
 
-See xref:#A-C-f4[C::f4]
+See <>
 
 
 
@@ -272,7 +272,7 @@ f4();
 == <>::f1
 
 
-See xref:#f0[f0]
+See <>
 
 === Synopsis
 
@@ -288,7 +288,7 @@ f1();
 === Description
 
 
-See xref:#f0[::f0]
+See <>
 
 
 
@@ -998,7 +998,7 @@ f0();
 == f5
 
 
-See xref:#A-f1[A::f1]
+See <>
 
 === Synopsis
 
@@ -1014,7 +1014,7 @@ f5();
 === Description
 
 
-See xref:#A-f1[::A::f1]
+See <>
 
 
 
@@ -1022,7 +1022,7 @@ See xref:#A-f1[::A::f1]
 == f6
 
 
-See xref:#F-operator_bitnot[F::operator~]
+See <>
 
 === Synopsis
 
@@ -1038,81 +1038,81 @@ f6();
 === Description
 
 
-See xref:#F-operator_comma[F::operator,]
+See <>
 
-See xref:#F-operator_call[F::operator()]
+See <>
 
-See xref:#F-operator_subs[F::operator[]]
+See <>
 
-See xref:#F-operator_plus[F::operator+]
+See <>
 
-See xref:#F-operator_inc[F::operator++]
+See <>
 
-See xref:#F-operator_plus_eq[F::operator+=]
+See <>
 
-See xref:#F-operator_bitand[F::operator&]
+See <>
 
-See xref:#F-operator_and[F::operator&&]
+See <>
 
-See xref:#F-operator_and_eq[F::operator&=]
+See <>
 
-See xref:#F-operator_bitor[F::operator|]
+See <>
 
-See xref:#F-operator_or[F::operator||]
+See <>
 
-See xref:#F-operator_or_eq[F::operator|=]
+See <>
 
-See xref:#F-operator_minus[F::operator‐]
+See <>
 
-See xref:#F-operator_dec[F::operator‐‐]
+See <>
 
-See xref:#F-operator_minus_eq[F::operator‐=]
+See <>
 
-See xref:#F-operator_ptr[F::operator‐>]
+See <>
 
-See xref:#F-operator_ptrmem[F::operator‐>*]
+See <>
 
-See xref:#F-operator_lt[F::operator<]
+See <>
 
-See xref:#F-operator_lshift[F::operator<<]
+See <>
 
-See xref:#F-operator_lshift_eq[F::operator<<=]
+See <>
 
-See xref:#F-operator_le[F::operator<=]
+See <>
 
-See xref:#F-operator_3way[F::operator<=>]
+See <>
 
-See xref:#F-operator_gt[F::operator>]
+See <>
 
-See xref:#F-operator_rshift[F::operator>>]
+See <>
 
-See xref:#F-operator_rshift_eq[F::operator>>=]
+See <>
 
-See xref:#F-operator_ge[F::operator>=]
+See <>
 
-See xref:#F-operator_star[F::operator*]
+See <>
 
-See xref:#F-operator_star_eq[F::operator*=]
+See <>
 
-See xref:#F-operator_mod[F::operator%]
+See <>
 
-See xref:#F-operator_mod_eq[F::operator%=]
+See <>
 
-See xref:#F-operator_slash[F::operator/]
+See <>
 
-See xref:#F-operator_slash_eq[F::operator/=]
+See <>
 
-See xref:#F-operator_xor[F::operatorˆ]
+See <>
 
-See xref:#F-operator_xor_eq[F::operatorˆ=]
+See <>
 
-See xref:#F-operator_assign[F::operator=]
+See <>
 
-See xref:#F-operator_eq[F::operator==]
+See <>
 
-See xref:#F-operator_not[F::operator!]
+See <>
 
-See xref:#F-operator_not_eq[F::operator!=]
+See <>
 
 
 
diff --git a/test-files/golden-tests/javadoc/ref/ref.html b/test-files/golden-tests/javadoc/ref/ref.html
index 1d7337a57c..d9a14fe844 100644
--- a/test-files/golden-tests/javadoc/ref/ref.html
+++ b/test-files/golden-tests/javadoc/ref/ref.html
@@ -45,13 +45,11 @@ 
    Functions
    
 
 
 
-f0 
+f0 
 
-f5 See A::f1
-
+f5 See A::f1
 
-f6 See F::operator~
-
+f6 See F::operator~
 
 
 
@@ -70,12 +68,11 @@ 
    Types
    
 
 
 
-B See f1
-
+B See f1
 
-C 
+C 
 
-D 
+D 
 
 
 
@@ -89,8 +86,7 @@ 
    Functions
    
 
 
 
-f1 See f0
-
+f1 See f0
 
 
 
@@ -99,8 +95,7 @@ 
    Functions
    
 
    
 
    A::B
    
 
    
-See f1
-
+See f1
 
 
    
 
    
@@ -132,10 +127,8 @@ 
    Member Functions
    
 
 
    
 
    Description
    
-
    See A::f1
    
-
    See ::A::f1
    
-
-
+
    See A::f1
    
+
    See ::A::f1
    
 
    
 
 
    
@@ -243,8 +236,7 @@ 
    Types
    
 
 
 
-E See f3
-
+E See f3
 
 
 
@@ -270,8 +262,7 @@ 
    Member Functions
    
 
    
 
    A::D::E
    
 
    
-See f3
-
+See f3
 
 
    
 
    
@@ -289,10 +280,8 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    See f4
    
-
    See C::f4
    
-
-
+
    See f4
    
+
    See C::f4
    
 
    
 
    
 
    
@@ -315,8 +304,7 @@ 
    Synopsis
    
 
    
 
    A::f1
    
 
    
-See f0
-
+See f0
 
 
    
 
    
@@ -333,9 +321,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    See ::f0
    
-
-
+
    See ::f0
    
 
    
 
 
    
@@ -1088,8 +1074,7 @@ 
    Synopsis
    
 
    
 
    f5
    
 
    
-See A::f1
-
+See A::f1
 
 
    
 
    
@@ -1106,17 +1091,14 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    See ::A::f1
    
-
-
+
    See ::A::f1
    
 
    
 
 
    
 
    
 
    f6
    
 
 
    
@@ -1133,46 +1115,44 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    See F::operator,
    
-
    See F::operator()
    
-
    See F::operator[]
    
-
    See F::operator+
    
-
    See F::operator++
    
-
    See F::operator+=
    
-
    See F::operator&
    
-
    See F::operator&&
    
-
    See F::operator&=
    
-
    See F::operator|
    
-
    See F::operator||
    
-
    See F::operator|=
    
-
    See F::operator-
    
-
    See F::operator--
    
-
    See F::operator-=
    
-
    See F::operator->
    
-
    See F::operator->*
    
-
    See F::operator<
    
-
    See F::operator<<
    
-
    See F::operator<<=
    
-
    See F::operator<=
    
-
    See F::operator<=>
    
-
    See F::operator>
    
-
    See F::operator>>
    
-
    See F::operator>>=
    
-
    See F::operator>=
    
-
    See F::operator*
    
-
    See F::operator*=
    
-
    See F::operator%
    
-
    See F::operator%=
    
-
    See F::operator/
    
-
    See F::operator/=
    
-
    See F::operator^
    
-
    See F::operator^=
    
-
    See F::operator=
    
-
    See F::operator==
    
-
    See F::operator!
    
-
    See F::operator!=
    
-
-
+
    See F::operator,
    
+
    See F::operator()
    
+
    See F::operator[]
    
+
    See F::operator+
    
+
    See F::operator++
    
+
    See F::operator+=
    
+
    See F::operator&
    
+
    See F::operator&&
    
+
    See F::operator&=
    
+
    See F::operator|
    
+
    See F::operator||
    
+
    See F::operator|=
    
+
    See F::operator-
    
+
    See F::operator--
    
+
    See F::operator-=
    
+
    See F::operator->
    
+
    See F::operator->*
    
+
    See F::operator<
    
+
    See F::operator<<
    
+
    See F::operator<<=
    
+
    See F::operator<=
    
+
    See F::operator<=>
    
+
    See F::operator>
    
+
    See F::operator>>
    
+
    See F::operator>>=
    
+
    See F::operator>=
    
+
    See F::operator*
    
+
    See F::operator*=
    
+
    See F::operator%
    
+
    See F::operator%=
    
+
    See F::operator/
    
+
    See F::operator/=
    
+
    See F::operator^
    
+
    See F::operator^=
    
+
    See F::operator=
    
+
    See F::operator==
    
+
    See F::operator!
    
+
    See F::operator!=
    
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/relates/relates.adoc b/test-files/golden-tests/javadoc/relates/relates.adoc
index c6cf07ef4e..1b404df4fa 100644
--- a/test-files/golden-tests/javadoc/relates/relates.adoc
+++ b/test-files/golden-tests/javadoc/relates/relates.adoc
@@ -98,13 +98,6 @@ void
 f();
 ----
 
-=== Description
-
-
-
-
-
-
 
 
 [.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/javadoc/relates/relates.html b/test-files/golden-tests/javadoc/relates/relates.html
index c5a3d3f188..48bb86e3e6 100644
--- a/test-files/golden-tests/javadoc/relates/relates.html
+++ b/test-files/golden-tests/javadoc/relates/relates.html
@@ -19,11 +19,9 @@ 
    Types
    
 
 
 
-A A brief for A.
-
+A A brief for A.
 
-B A brief for B
-
+B A brief for B
 
 
 
@@ -37,8 +35,7 @@ 
    Functions
    
 
 
 
-f A brief for f.
-
+f A brief for f.
 
 
 
@@ -47,8 +44,7 @@ 
    Functions
    
 
    
 
    A
    
 
    
-A brief for A.
-
+A brief for A.
 
 
    
 
    
@@ -69,8 +65,7 @@ 
    Synopsis
    
 
    
 
    B
    
 
    
-A brief for B
-
+A brief for B
 
 
    
 
    
@@ -91,8 +86,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-A brief for f.
-
+A brief for f.
 
 
    
 
    
@@ -106,12 +100,6 @@ 
    Synopsis
    
 f();
     
 
    
-
-
    
-
    Description
    
-
    
-
-
 
    
 
 
diff --git a/test-files/golden-tests/javadoc/relates/relates.xml b/test-files/golden-tests/javadoc/relates/relates.xml
index 23446ff4a6..7c941d3a84 100644
--- a/test-files/golden-tests/javadoc/relates/relates.xml
+++ b/test-files/golden-tests/javadoc/relates/relates.xml
@@ -24,9 +24,6 @@
       
         A brief for f.
       
-      
-        A
-      
     
   
 
diff --git a/test-files/golden-tests/javadoc/throw/throw.html b/test-files/golden-tests/javadoc/throw/throw.html
index bb66b5c1dc..dd7ecca0ac 100644
--- a/test-files/golden-tests/javadoc/throw/throw.html
+++ b/test-files/golden-tests/javadoc/throw/throw.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f brief
-
+f brief
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -57,8 +55,7 @@ 
    Exceptions
    
 
 
 std::length_error
-
    dest_size < ipv4_address::max_str_len
    
-
+dest_size < ipv4_address::max_str_len
 
 
 
diff --git a/test-files/golden-tests/javadoc/tparam/tparam-1.html b/test-files/golden-tests/javadoc/tparam/tparam-1.html
index 3c469a21ff..763a3245c8 100644
--- a/test-files/golden-tests/javadoc/tparam/tparam-1.html
+++ b/test-files/golden-tests/javadoc/tparam/tparam-1.html
@@ -19,10 +19,9 @@ 
    Functions
    
 
 
 
-f0 
+f0 
 
-f1 brief
-
+f1 brief
 
 
 
@@ -55,7 +54,7 @@ 
    Template Parameters
    
 
 
 T
-
+
 
 
 
@@ -65,8 +64,7 @@ 
    Template Parameters
    
 
    
 
    f1
    
 
    
-brief
-
+brief
 
 
    
 
    
@@ -84,9 +82,7 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    desc
    
-
-
+
    desc
    
 
    
 
    
 
    Template Parameters
    
@@ -100,8 +96,7 @@ 
    Template Parameters
    
 
 
 T
-
    type
    
-
+type
 
 
 
diff --git a/test-files/golden-tests/snippets/distance.adoc b/test-files/golden-tests/snippets/distance.adoc
index f17d9af4ae..230ad7509a 100644
--- a/test-files/golden-tests/snippets/distance.adoc
+++ b/test-files/golden-tests/snippets/distance.adoc
@@ -25,7 +25,7 @@ distance(
 === Description
 
 
-This function returns the distance between two points    according to the Euclidean distance formula.
+This function returns the distance between two points according to the Euclidean distance formula.
 
 
 
diff --git a/test-files/golden-tests/snippets/distance.html b/test-files/golden-tests/snippets/distance.html
index 2b8461575d..7909175e41 100644
--- a/test-files/golden-tests/snippets/distance.html
+++ b/test-files/golden-tests/snippets/distance.html
@@ -9,8 +9,7 @@ 
    Reference
    
 
    
 
    distance
    
 
    
-Return the distance between two points
-
+Return the distance between two points
 
 
    
 
    
@@ -31,14 +30,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This function returns the distance between two points    according to the Euclidean distance formula.
    
-
-
+
    This function returns the distance between two points according to the Euclidean distance formula.
    
 
    
 
    
 
    Return Value
    
-
    The distance between the two points
    
-
+The distance between the two points
 
    
 
    
 
    Parameters
    
@@ -52,23 +48,19 @@ 
    Parameters
    
 
 
 x0
-
    The x-coordinate of the first point
    
-
+The x-coordinate of the first point
 
 
 y0
-
    The y-coordinate of the first point
    
-
+The y-coordinate of the first point
 
 
 x1
-
    The x-coordinate of the second point
    
-
+The x-coordinate of the second point
 
 
 y1
-
    The y-coordinate of the second point
    
-
+The y-coordinate of the second point
 
 
 
diff --git a/test-files/golden-tests/snippets/distance.xml b/test-files/golden-tests/snippets/distance.xml
index 9f71037de3..839e18c1d6 100644
--- a/test-files/golden-tests/snippets/distance.xml
+++ b/test-files/golden-tests/snippets/distance.xml
@@ -24,22 +24,22 @@
         Return the distance between two points
       
       
-        This function returns the distance between two points    according to the Euclidean distance formula.
+        This function returns the distance between two points according to the Euclidean distance formula.
       
       
         The distance between the two points
       
       
-        The x-coordinate of the first point    
+        The x-coordinate of the first point
       
       
-        The y-coordinate of the first point    
+        The y-coordinate of the first point
       
       
-        The x-coordinate of the second point    
+        The x-coordinate of the second point
       
       
-        The y-coordinate of the second point    
+        The y-coordinate of the second point
       
     
   
diff --git a/test-files/golden-tests/snippets/is_prime.html b/test-files/golden-tests/snippets/is_prime.html
index 6ca16902d7..03bcfb747b 100644
--- a/test-files/golden-tests/snippets/is_prime.html
+++ b/test-files/golden-tests/snippets/is_prime.html
@@ -9,8 +9,7 @@ 
    Reference
    
 
    
 
    is_prime
    
 
    
-Return true if a number is prime.
-
+Return true if a number is prime.
 
 
    
 
    
@@ -28,14 +27,11 @@ 
    Synopsis
    
 
    
 
    Description
    
 
    Complexity
    
-
    Linear in n.
    
-
-
+
    Linear in n.
    
 
    
 
    
 
    Return Value
    
-
    Whether or not n is prime.
    
-
+Whether or not n is prime.
 
    
 
    
 
    Parameters
    
@@ -49,8 +45,7 @@ 
    Parameters
    
 
 
 n
-
    The number to test
    
-
+The number to test
 
 
 
diff --git a/test-files/golden-tests/snippets/sqrt.adoc b/test-files/golden-tests/snippets/sqrt.adoc
index e2708ab51a..460195c8e5 100644
--- a/test-files/golden-tests/snippets/sqrt.adoc
+++ b/test-files/golden-tests/snippets/sqrt.adoc
@@ -23,7 +23,7 @@ requires std::is_integral_v<T>;
 === Description
 
 
-This function calculates the square root of a    given integral value using bit manipulation.
+This function calculates the square root of a given integral value using bit manipulation.
 
 
 
diff --git a/test-files/golden-tests/snippets/sqrt.html b/test-files/golden-tests/snippets/sqrt.html
index 986f67ba4e..a82a806443 100644
--- a/test-files/golden-tests/snippets/sqrt.html
+++ b/test-files/golden-tests/snippets/sqrt.html
@@ -9,8 +9,7 @@ 
    Reference
    
 
    
 
    sqrt
    
 
    
-Computes the square root of an integral value.
-
+Computes the square root of an integral value.
 
 
    
 
    
@@ -29,9 +28,7 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This function calculates the square root of a    given integral value using bit manipulation.
    
-
-
+
    This function calculates the square root of a given integral value using bit manipulation.
    
 
    
 
    
 
    Exceptions
    
@@ -45,16 +42,14 @@ 
    Exceptions
    
 
 
 std::invalid_argument
-
    if the input value is negative.
    
-
+if the input value is negative.
 
 
 
 
    
 
    
 
    Return Value
    
-
    The square root of the input value.
    
-
+The square root of the input value.
 
    
 
    
 
    Template Parameters
    
@@ -68,8 +63,7 @@ 
    Template Parameters
    
 
 
 T
-
    The type of the input value. Must be an integral type.
    
-
+The type of the input value. Must be an integral type.
 
 
 
@@ -86,8 +80,7 @@ 
    Parameters
    
 
 
 value
-
    The integral value to compute the square root of.
    
-
+The integral value to compute the square root of.
 
 
 
diff --git a/test-files/golden-tests/snippets/sqrt.xml b/test-files/golden-tests/snippets/sqrt.xml
index a22cb09e30..c087a353b6 100644
--- a/test-files/golden-tests/snippets/sqrt.xml
+++ b/test-files/golden-tests/snippets/sqrt.xml
@@ -17,16 +17,16 @@
           Computes the square root of an integral value.
         
         
-          This function calculates the square root of a    given integral value using bit manipulation.
+          This function calculates the square root of a given integral value using bit manipulation.
         
         
           The square root of the input value.
         
         
-          The integral value to compute the square root of.    
+          The integral value to compute the square root of.
         
         
-          The type of the input value. Must be an integral type.    
+          The type of the input value. Must be an integral type.
         
         
           if the input value is negative.
diff --git a/test-files/golden-tests/snippets/terminate.html b/test-files/golden-tests/snippets/terminate.html
index 405e9df2b2..992ca8f668 100644
--- a/test-files/golden-tests/snippets/terminate.html
+++ b/test-files/golden-tests/snippets/terminate.html
@@ -9,8 +9,7 @@ 
    Reference
    
 
    
 
    terminate
    
 
    
-Exit the program.
-
+Exit the program.
 
 
    
 
    
@@ -28,13 +27,11 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    The program will end immediately.
    
-
    
+
    The program will end immediately.
    
+
    
 
    NOTE
    
-
    This function does not return.
    
+
    This function does not return.
    
 
    
-
-
 
    
 
    
 
diff --git a/test-files/golden-tests/symbols/concept/requires-clause.html b/test-files/golden-tests/symbols/concept/requires-clause.html
index 6e5977fb66..65c50687a2 100644
--- a/test-files/golden-tests/symbols/concept/requires-clause.html
+++ b/test-files/golden-tests/symbols/concept/requires-clause.html
@@ -34,9 +34,9 @@ 
    Functions
    
 
 
 
-f 
+f 
 
-g 
+g 
 
 
 
diff --git a/test-files/golden-tests/symbols/enum/enum.html b/test-files/golden-tests/symbols/enum/enum.html
index 3259b762f8..1dd9ff1b4f 100644
--- a/test-files/golden-tests/symbols/enum/enum.html
+++ b/test-files/golden-tests/symbols/enum/enum.html
@@ -19,15 +19,13 @@ 
    Enums
    
 
 
 
-E0 E0 brief.
-
+E0 E0 brief.
 
-E1 
+E1 
 
-E2 E2 brief.
-
+E2 E2 brief.
 
-E3 
+E3 
 
 
 
@@ -36,8 +34,7 @@ 
    Enums
    
 
    
 
    E0
    
 
    
-E0 brief.
-
+E0 brief.
 
 
    
 
    
@@ -63,22 +60,18 @@ 
    Members
    
 
 
 e0
-e0 brief.
-
+e0 brief.
 
 
 e1
-e1 brief.
-
+e1 brief.
 
 
 
 
    
 
    
 
    Description
    
-
    E0 description.
    
-
-
+
    E0 description.
    
 
    
 
 
    
@@ -107,11 +100,11 @@ 
    Members
    
 
 
 e2
-
+
 
 
 e3
-
+
 
 
 
@@ -121,8 +114,7 @@ 
    Members
    
 
    
 
    E2
    
 
    
-E2 brief.
-
+E2 brief.
 
 
    
 
    
@@ -148,22 +140,18 @@ 
    Members
    
 
 
 e4
-e4 brief.
-
+e4 brief.
 
 
 e5
-e5 brief.
-
+e5 brief.
 
 
 
 
    
 
    
 
    Description
    
-
    E2 description.
    
-
-
+
    E2 description.
    
 
    
 
 
    
@@ -192,11 +180,11 @@ 
    Members
    
 
 
 e6
-
+
 
 
 e7
-
+
 
 
 
diff --git a/test-files/golden-tests/symbols/friend/friend-1.html b/test-files/golden-tests/symbols/friend/friend-1.html
index e724997c0a..dafe3a0b38 100644
--- a/test-files/golden-tests/symbols/friend/friend-1.html
+++ b/test-files/golden-tests/symbols/friend/friend-1.html
@@ -32,8 +32,7 @@ 
    Functions
    
 
 
 
-f f
-
+f f
 
 
 
@@ -62,8 +61,7 @@ 
    Friends
    
 
 
 
-f f
-
+f f
 
 
 
@@ -74,8 +72,7 @@ 
    Friends
    
 
    
 
    f
    
 
    
-f
-
+f
 
 
    
 
    
@@ -96,8 +93,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-f
-
+f
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/friend/friend-2.html b/test-files/golden-tests/symbols/friend/friend-2.html
index 1cc2630c3f..a1f06ad8a6 100644
--- a/test-files/golden-tests/symbols/friend/friend-2.html
+++ b/test-files/golden-tests/symbols/friend/friend-2.html
@@ -32,8 +32,7 @@ 
    Functions
    
 
 
 
-f f
-
+f f
 
 
 
@@ -62,8 +61,7 @@ 
    Friends
    
 
 
 
-f f
-
+f f
 
 
 
@@ -74,8 +72,7 @@ 
    Friends
    
 
    
 
    f
    
 
    
-f
-
+f
 
 
    
 
    
@@ -96,8 +93,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-f
-
+f
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/friend/friend-3.html b/test-files/golden-tests/symbols/friend/friend-3.html
index 653c027813..a23247be2d 100644
--- a/test-files/golden-tests/symbols/friend/friend-3.html
+++ b/test-files/golden-tests/symbols/friend/friend-3.html
@@ -34,8 +34,7 @@ 
    Functions
    
 
 
 
-f T::f
-
+f T::f
 
 
 
@@ -64,8 +63,7 @@ 
    Friends
    
 
 
 
-f T::f
-
+f T::f
 
 
 
@@ -76,8 +74,7 @@ 
    Friends
    
 
    
 
    f
    
 
    
-T::f
-
+T::f
 
 
    
 
    
@@ -145,8 +142,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-T::f
-
+T::f
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/friend/friend-4.html b/test-files/golden-tests/symbols/friend/friend-4.html
index 87582a6037..5d10bc8606 100644
--- a/test-files/golden-tests/symbols/friend/friend-4.html
+++ b/test-files/golden-tests/symbols/friend/friend-4.html
@@ -34,8 +34,7 @@ 
    Functions
    
 
 
 
-f U::f
-
+f U::f
 
 
 
@@ -111,8 +110,7 @@ 
    Friends
    
 
 
 
-f U::f
-
+f U::f
 
 
 
@@ -123,8 +121,7 @@ 
    Friends
    
 
    
 
    f
    
 
    
-U::f
-
+U::f
 
 
    
 
    
@@ -145,8 +142,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-U::f
-
+U::f
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/friend/friend-5.html b/test-files/golden-tests/symbols/friend/friend-5.html
index afc49b6b89..d64ced7023 100644
--- a/test-files/golden-tests/symbols/friend/friend-5.html
+++ b/test-files/golden-tests/symbols/friend/friend-5.html
@@ -34,8 +34,7 @@ 
    Functions
    
 
 
 
-f f
-
+f f
 
 
 
@@ -138,8 +137,7 @@ 
    Synopsis
    
 
    
 
    f
    
 
    
-f
-
+f
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/friend/friend-6.html b/test-files/golden-tests/symbols/friend/friend-6.html
index 364f2ccbde..07699e23ca 100644
--- a/test-files/golden-tests/symbols/friend/friend-6.html
+++ b/test-files/golden-tests/symbols/friend/friend-6.html
@@ -19,16 +19,13 @@ 
    Types
    
 
 
 
-T Struct T brief
-
+T Struct T brief
 
-U Struct U brief
-
+U Struct U brief
 
-V Struct V brief
-
+V Struct V brief
 
-Z 
+Z 
 
 
 
@@ -37,8 +34,7 @@ 
    Types
    
 
    
 
    T
    
 
    
-Struct T brief
-
+Struct T brief
 
 
    
 
    
@@ -62,11 +58,9 @@ 
    Friends
    
 
 
 
-class Z Friend class Z brief
-
+class Z Friend class Z brief
 
-int Friend int brief
-
+int Friend int brief
 
 
 
@@ -77,8 +71,7 @@ 
    Friends
    
 
    
 
    Z
    
 
    
-Friend class Z brief
-
+Friend class Z brief
 
 
    
 
    
@@ -97,8 +90,7 @@ 
    Synopsis
    
 
    
 
    int
    
 
    
-Friend int brief
-
+Friend int brief
 
 
    
 
    
@@ -117,8 +109,7 @@ 
    Synopsis
    
 
    
 
    U
    
 
    
-Struct U brief
-
+Struct U brief
 
 
    
 
    
@@ -142,8 +133,7 @@ 
    Friends
    
 
 
 
-T Friend T brief
-
+T Friend T brief
 
 
 
@@ -154,8 +144,7 @@ 
    Friends
    
 
    
 
    T
    
 
    
-Friend T brief
-
+Friend T brief
 
 
    
 
    
@@ -174,8 +163,7 @@ 
    Synopsis
    
 
    
 
    V
    
 
    
-Struct V brief
-
+Struct V brief
 
 
    
 
    
@@ -199,8 +187,7 @@ 
    Friends
    
 
 
 
-struct U Friend struct U brief
-
+struct U Friend struct U brief
 
 
 
@@ -211,8 +198,7 @@ 
    Friends
    
 
    
 
    U
    
 
    
-Friend struct U brief
-
+Friend struct U brief
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/function/explicit-ctor.html b/test-files/golden-tests/symbols/function/explicit-ctor.html
index 5e962d5452..895d894510 100644
--- a/test-files/golden-tests/symbols/function/explicit-ctor.html
+++ b/test-files/golden-tests/symbols/function/explicit-ctor.html
@@ -53,7 +53,7 @@ 
    Member Functions
    
 
 
 
-Explicit         [constructor]
+Explicit         [constructor]
 
 
 
@@ -200,7 +200,7 @@ 
    Member Functions
    
 
 
 
-ExplicitExpression         [constructor]
+ExplicitExpression         [constructor]
 
 
 
@@ -346,7 +346,7 @@ 
    Member Functions
    
 
 
 
-ExplicitFalse         [constructor]
+ExplicitFalse         [constructor]
 
 
 
@@ -492,7 +492,7 @@ 
    Member Functions
    
 
 
 
-ExplicitTrue         [constructor]
+ExplicitTrue         [constructor]
 
 
 
diff --git a/test-files/golden-tests/symbols/function/explicit-object-parameter.html b/test-files/golden-tests/symbols/function/explicit-object-parameter.html
index 25e9ce5531..f381ca5afd 100644
--- a/test-files/golden-tests/symbols/function/explicit-object-parameter.html
+++ b/test-files/golden-tests/symbols/function/explicit-object-parameter.html
@@ -47,7 +47,7 @@ 
    Member Functions
    
 
 
 
-value 
+value 
 
 
 
diff --git a/test-files/golden-tests/symbols/function/merge-params.html b/test-files/golden-tests/symbols/function/merge-params.html
index 4b6da2b94a..ba01b3c04f 100644
--- a/test-files/golden-tests/symbols/function/merge-params.html
+++ b/test-files/golden-tests/symbols/function/merge-params.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f Function
-
+f Function
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-Function
-
+Function
 
 
    
 
    
@@ -59,13 +57,11 @@ 
    Parameters
    
 
 
 a
-
    The first parameter.
    
-
+The first parameter.
 
 
 b
-
    The second parameter.
    
-
+The second parameter.
 
 
 
diff --git a/test-files/golden-tests/symbols/function/merge-params.xml b/test-files/golden-tests/symbols/function/merge-params.xml
index f3be164186..d04190c2cc 100644
--- a/test-files/golden-tests/symbols/function/merge-params.xml
+++ b/test-files/golden-tests/symbols/function/merge-params.xml
@@ -17,7 +17,7 @@
         Function
       
       
-        The first parameter.    
+        The first parameter.
       
       
         The second parameter.
diff --git a/test-files/golden-tests/symbols/function/merge-tparams.html b/test-files/golden-tests/symbols/function/merge-tparams.html
index 83c853e8a1..f020841846 100644
--- a/test-files/golden-tests/symbols/function/merge-tparams.html
+++ b/test-files/golden-tests/symbols/function/merge-tparams.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f Function
-
+f Function
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-Function
-
+Function
 
 
    
 
    
@@ -60,13 +58,11 @@ 
    Template Parameters
    
 
 
 T
-
    The first template parameter.
    
-
+The first template parameter.
 
 
 U
-
    The second template parameter.
    
-
+The second template parameter.
 
 
 
diff --git a/test-files/golden-tests/symbols/function/merge-tparams.xml b/test-files/golden-tests/symbols/function/merge-tparams.xml
index 66622b56c1..b168b828f1 100644
--- a/test-files/golden-tests/symbols/function/merge-tparams.xml
+++ b/test-files/golden-tests/symbols/function/merge-tparams.xml
@@ -14,7 +14,7 @@
           Function
         
         
-          The first template parameter.    
+          The first template parameter.
         
         
           The second template parameter.
diff --git a/test-files/golden-tests/symbols/function/sfinae.html b/test-files/golden-tests/symbols/function/sfinae.html
index ac9f540a09..e133753a1c 100644
--- a/test-files/golden-tests/symbols/function/sfinae.html
+++ b/test-files/golden-tests/symbols/function/sfinae.html
@@ -32,17 +32,13 @@ 
    Types
    
 
 
 
-A The partial specialization of A is enabled via a template parameter
-
+A The partial specialization of A is enabled via a template parameter
 
-A<T> Specialization for floating point types
-
+A<T> Specialization for floating point types
 
-S SFINAE with std::void_t
-
+S SFINAE with std::void_t
 
-S<T, std::void_t<T::a::b>> SFINAE with std::void_t
-
+S<T, std::void_t<T::a::b>> SFINAE with std::void_t
 
 
 
@@ -56,35 +52,25 @@ 
    Functions
    
 
 
 
-f1 Enabled via return type
-
+f1 Enabled via return type
 
-f10 Enabled via type template parameter
-
+f10 Enabled via type template parameter
 
-f2 Enabling a specified return type
-
+f2 Enabling a specified return type
 
-f3 Enabling a specified return type in another namespace
-
+f3 Enabling a specified return type in another namespace
 
-f4 Enabled via return type with std::enable_if
-
+f4 Enabled via return type with std::enable_if
 
-f5 Enabled via a non-type template parameter with helper
-
+f5 Enabled via a non-type template parameter with helper
 
-f6 Enabled via a non-type template parameter without helper
-
+f6 Enabled via a non-type template parameter without helper
 
-f7 Enabled via a non-type template parameter using int instead of bool
-
+f7 Enabled via a non-type template parameter using int instead of bool
 
-f8 Enabled via parameter without helper
-
+f8 Enabled via parameter without helper
 
-f9 Enabled via parameter with helper
-
+f9 Enabled via parameter with helper
 
 
 
@@ -128,8 +114,7 @@ 
    Synopsis
    
 
    
 
    A
    
 
    
-The partial specialization of A is enabled via a template parameter
-
+The partial specialization of A is enabled via a template parameter
 
 
    
 
    
@@ -153,8 +138,7 @@ 
    Synopsis
    
 
    
 
    A<T>
    
 
    
-Specialization for floating point types
-
+Specialization for floating point types
 
 
    
 
    
@@ -177,8 +161,7 @@ 
    Synopsis
    
 
    
 
    S
    
 
    
-SFINAE with std::void_t
-
+SFINAE with std::void_t
 
 
    
 
    
@@ -231,8 +214,7 @@ 
    Synopsis
    
 
    
 
    S<T, std::void_t<T::a::b>>
    
 
    
-SFINAE with std::void_t
-
+SFINAE with std::void_t
 
 
    
 
    
@@ -283,8 +265,7 @@ 
    Synopsis
    
 
    
 
    f1
    
 
    
-Enabled via return type
-
+Enabled via return type
 
 
    
 
    
@@ -306,8 +287,7 @@ 
    Synopsis
    
 
    
 
    f10
    
 
    
-Enabled via type template parameter
-
+Enabled via type template parameter
 
 
    
 
    
@@ -326,19 +306,16 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    This pattern should not be used because the function signature is unmodified and therefore only supports one overload.
    
-
    It's a common mistake is to declare two function templates that differ only in their default template arguments.
    
-
    This does not work because the declarations are treated as redeclarations of the same function template (default template arguments are not accounted for in function template equivalence).
    
-
-
+
    This pattern should not be used because the function signature is unmodified and therefore only supports one overload.
    
+
    It's a common mistake is to declare two function templates that differ only in their default template arguments.
    
+
    This does not work because the declarations are treated as redeclarations of the same function template (default template arguments are not accounted for in function template equivalence).
    
 
    
 
 
    
 
    
 
    f2
    
 
    
-Enabling a specified return type
-
+Enabling a specified return type
 
 
    
 
    
@@ -360,8 +337,7 @@ 
    Synopsis
    
 
    
 
    f3
    
 
    
-Enabling a specified return type in another namespace
-
+Enabling a specified return type in another namespace
 
 
    
 
    
@@ -383,8 +359,7 @@ 
    Synopsis
    
 
    
 
    f4
    
 
    
-Enabled via return type with std::enable_if
-
+Enabled via return type with std::enable_if
 
 
    
 
    
@@ -406,8 +381,7 @@ 
    Synopsis
    
 
    
 
    f5
    
 
    
-Enabled via a non-type template parameter with helper
-
+Enabled via a non-type template parameter with helper
 
 
    
 
    
@@ -429,8 +403,7 @@ 
    Synopsis
    
 
    
 
    f6
    
 
    
-Enabled via a non-type template parameter without helper
-
+Enabled via a non-type template parameter without helper
 
 
    
 
    
@@ -452,8 +425,7 @@ 
    Synopsis
    
 
    
 
    f7
    
 
    
-Enabled via a non-type template parameter using int instead of bool
-
+Enabled via a non-type template parameter using int instead of bool
 
 
    
 
    
@@ -475,8 +447,7 @@ 
    Synopsis
    
 
    
 
    f8
    
 
    
-Enabled via parameter without helper
-
+Enabled via parameter without helper
 
 
    
 
    
@@ -498,8 +469,7 @@ 
    Synopsis
    
 
    
 
    f9
    
 
    
-Enabled via parameter with helper
-
+Enabled via parameter with helper
 
 
    
 
    
diff --git a/test-files/golden-tests/symbols/overloads/overloads-brief.adoc b/test-files/golden-tests/symbols/overloads/overloads-brief.adoc
index d8dc0070fe..d033bbdc63 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-brief.adoc
+++ b/test-files/golden-tests/symbols/overloads/overloads-brief.adoc
@@ -449,7 +449,7 @@ operator‐();
 === Description
 
 
-No way to generate a brief from the        operator kind because there are        unary and binary operators.
+No way to generate a brief from the operator kind because there are unary and binary operators.
 
 
 
@@ -478,7 +478,7 @@ operator‐(<> const&);
 === Description
 
 
-No way to generate a brief from the        operator kind.
+No way to generate a brief from the operator kind.
 
 
 
diff --git a/test-files/golden-tests/symbols/overloads/overloads-brief.html b/test-files/golden-tests/symbols/overloads/overloads-brief.html
index 6747120649..428de22e45 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-brief.html
+++ b/test-files/golden-tests/symbols/overloads/overloads-brief.html
@@ -19,11 +19,9 @@ 
    Types
    
 
 
 
-A Overload briefs from function or operator classes
-
+A Overload briefs from function or operator classes
 
-B Auxiliary class
-
+B Auxiliary class
 
 
 
@@ -37,14 +35,11 @@ 
    Functions
    
 
 
 
-no_way_to_infer_this_brief no_way_to_infer_this_brief overloads
-
+no_way_to_infer_this_brief no_way_to_infer_this_brief overloads
 
-operator+ Unary plus operators
-
+operator+ Unary plus operators
 
-sameBrief Function with same brief
-
+sameBrief Function with same brief
 
 
 
@@ -53,8 +48,7 @@ 
    Functions
    
 
    
 
    A
    
 
    
-Overload briefs from function or operator classes
-
+Overload briefs from function or operator classes
 
 
    
 
    
@@ -78,17 +72,13 @@ 
    Member Functions
    
 
 
 
-A         [constructor]Constructors
-
+A         [constructor]Constructors
 
-operator= Assignment operators
-
+operator= Assignment operators
 
-operator+ Addition operators
-
+operator+ Addition operators
 
-operator- operator- overloads
-
+operator- operator- overloads
 
 
 
@@ -99,8 +89,7 @@ 
    Member Functions
    
 
    
 
    A::A
    
 
    
-Constructors
-
+Constructors
 
 
    
 
    
@@ -108,11 +97,7 @@ 
    A::A
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    First constructor
-
-
    
-
+
    First constructor
    
 
 
     
@@ -120,11 +105,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Second constructor
-
-
    
-
+
    Second constructor
    
 
 
     
@@ -146,8 +127,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -157,8 +137,7 @@ 
    Parameters
    
 
    
 
    A::A
    
 
    
-First constructor
-
+First constructor
 
 
    
 
    
@@ -177,8 +156,7 @@ 
    Synopsis
    
 
    
 
    A::A
    
 
    
-Second constructor
-
+Second constructor
 
 
    
 
    
@@ -204,8 +182,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -215,8 +192,7 @@ 
    Parameters
    
 
    
 
    A::operator=
    
 
    
-Assignment operators
-
+Assignment operators
 
 
    
 
    
@@ -224,11 +200,7 @@ 
    A::operator=
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    Assign from int
-
-
    
-
+
    Assign from int
    
 
 
     
@@ -237,11 +209,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Assign from A
-
-
    
-
+
    Assign from A
    
 
 
     
@@ -254,8 +222,7 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    *this
    
-
+*this
 
    
 
    
 
    Parameters
    
@@ -269,8 +236,7 @@ 
    Parameters
    
 
 
 a
-
    Describe b
    
-
+Describe b
 
 
 
@@ -280,8 +246,7 @@ 
    Parameters
    
 
    
 
    A::operator=
    
 
    
-Assign from int
-
+Assign from int
 
 
    
 
    
@@ -298,8 +263,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    *this
    
-
+*this
 
    
 
    
 
    Parameters
    
@@ -313,8 +277,7 @@ 
    Parameters
    
 
 
 a
-
    Describe b
    
-
+Describe b
 
 
 
@@ -324,8 +287,7 @@ 
    Parameters
    
 
    
 
    A::operator=
    
 
    
-Assign from A
-
+Assign from A
 
 
    
 
    
@@ -342,8 +304,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    *this
    
-
+*this
 
    
 
    
 
    Parameters
    
@@ -357,8 +318,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -368,8 +328,7 @@ 
    Parameters
    
 
    
 
    A::operator+
    
 
    
-Addition operators
-
+Addition operators
 
 
    
 
    
@@ -377,11 +336,7 @@ 
    A::operator+
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    Addition operator for ints
-
-
    
-
+
    Addition operator for ints
    
 
 
     
@@ -390,11 +345,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Addition operator for As
-
-
    
-
+
    Addition operator for As
    
 
 
     
@@ -407,8 +358,7 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    *this
    
-
+*this
 
    
 
    
 
    Parameters
    
@@ -422,8 +372,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -433,8 +382,7 @@ 
    Parameters
    
 
    
 
    A::operator+
    
 
    
-Addition operator for ints
-
+Addition operator for ints
 
 
    
 
    
@@ -451,8 +399,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    *this
    
-
+*this
 
    
 
    
 
    Parameters
    
@@ -466,8 +413,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -477,8 +423,7 @@ 
    Parameters
    
 
    
 
    A::operator+
    
 
    
-Addition operator for As
-
+Addition operator for As
 
 
    
 
    
@@ -495,8 +440,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    *this
    
-
+*this
 
    
 
    
 
    Parameters
    
@@ -510,8 +454,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -521,8 +464,7 @@ 
    Parameters
    
 
    
 
    A::operator-
    
 
    
-operator- overloads
-
+operator- overloads
 
 
    
 
    
@@ -530,11 +472,7 @@ 
    A::operator-
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    Unary operator- for A
-
-
    
-
+
    Unary operator- for A
    
 
 
     
@@ -543,11 +481,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Binary operator- for A
-
-
    
-
+
    Binary operator- for A
    
 
 
     
@@ -560,16 +494,14 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    Result
    
-
+Result
 
    
 
 
    
 
    
 
    A::operator-
    
 
    
-Unary operator- for A
-
+Unary operator- for A
 
 
    
 
    
@@ -586,22 +518,18 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    No way to generate a brief from the        operator kind because there are        unary and binary operators.
    
-
-
+
    No way to generate a brief from the operator kind because there are unary and binary operators.
    
 
    
 
    
 
    Return Value
    
-
    Result
    
-
+Result
 
    
 
 
    
 
    
 
    A::operator-
    
 
    
-Binary operator- for A
-
+Binary operator- for A
 
 
    
 
    
@@ -618,22 +546,18 @@ 
    Synopsis
    
 
    
 
    
 
    Description
    
-
    No way to generate a brief from the        operator kind.
    
-
-
+
    No way to generate a brief from the operator kind.
    
 
    
 
    
 
    Return Value
    
-
    Result
    
-
+Result
 
    
 
 
    
 
    
 
    B
    
 
    
-Auxiliary class
-
+Auxiliary class
 
 
    
 
    
@@ -654,8 +578,7 @@ 
    Synopsis
    
 
    
 
    no_way_to_infer_this_brief
    
 
    
-no_way_to_infer_this_brief overloads
-
+no_way_to_infer_this_brief overloads
 
 
    
 
    
@@ -663,11 +586,7 @@ 
    no_way_to_infer_this_brief
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    Function with no params
-
-
    
-
+
    Function with no params
    
 
 
     
@@ -676,11 +595,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Function with single param
-
-
    
-
+
    Function with single param
    
 
 
     
@@ -703,8 +618,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -714,8 +628,7 @@ 
    Parameters
    
 
    
 
    no_way_to_infer_this_brief
    
 
    
-Function with no params
-
+Function with no params
 
 
    
 
    
@@ -735,8 +648,7 @@ 
    Synopsis
    
 
    
 
    no_way_to_infer_this_brief
    
 
    
-Function with single param
-
+Function with single param
 
 
    
 
    
@@ -763,8 +675,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -774,8 +685,7 @@ 
    Parameters
    
 
    
 
    operator+
    
 
    
-Unary plus operators
-
+Unary plus operators
 
 
    
 
    
@@ -783,11 +693,7 @@ 
    operator+
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    Unary operator for A
-
-
    
-
+
    Unary operator for A
    
 
 
     
@@ -796,11 +702,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Unary operator for B
-
-
    
-
+
    Unary operator for B
    
 
 
     
@@ -813,16 +715,14 @@ 
    Synopses
    
 
    
 
    
 
    Return Value
    
-
    Result
    
-
+Result
 
    
 
 
    
 
    
 
    operator+
    
 
    
-Unary operator for A
-
+Unary operator for A
 
 
    
 
    
@@ -839,16 +739,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    Result
    
-
+Result
 
    
 
 
    
 
    
 
    operator+
    
 
    
-Unary operator for B
-
+Unary operator for B
 
 
    
 
    
@@ -865,16 +763,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    Result
    
-
+Result
 
    
 
 
    
 
    
 
    sameBrief
    
 
    
-Function with same brief
-
+Function with same brief
 
 
    
 
    
@@ -882,11 +778,7 @@ 
    sameBrief
    
 
    Synopses
    
 
    
 Declared in <overloads-brief.cpp>
    
-
    
-    Function with same brief
-
-
    
-
+
    Function with same brief
    
 
 
     
@@ -895,11 +787,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Function with same brief
-
-
    
-
+
    Function with same brief
    
 
 
     
@@ -924,13 +812,11 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 b
-
    Describe b
    
-
+Describe b
 
 
 
@@ -940,8 +826,7 @@ 
    Parameters
    
 
    
 
    sameBrief
    
 
    
-Function with same brief
-
+Function with same brief
 
 
    
 
    
@@ -968,8 +853,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -979,8 +863,7 @@ 
    Parameters
    
 
    
 
    sameBrief
    
 
    
-Function with same brief
-
+Function with same brief
 
 
    
 
    
@@ -1009,13 +892,11 @@ 
    Parameters
    
 
 
 a
-
    Describe a again
    
-
+Describe a again
 
 
 b
-
    Describe b
    
-
+Describe b
 
 
 
diff --git a/test-files/golden-tests/symbols/overloads/overloads-brief.xml b/test-files/golden-tests/symbols/overloads/overloads-brief.xml
index 4027d9c715..5abf31957c 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-brief.xml
+++ b/test-files/golden-tests/symbols/overloads/overloads-brief.xml
@@ -50,7 +50,7 @@
           *this
         
         
-          Describe b        
+          Describe b
         
       
     
@@ -75,7 +75,7 @@
           *this
         
         
-          Describe a        
+          Describe a
         
       
     
@@ -96,7 +96,7 @@
           *this
         
         
-          Describe a        
+          Describe a
         
       
     
@@ -119,7 +119,7 @@
           *this
         
         
-          Describe a        
+          Describe a
         
       
     
@@ -134,7 +134,7 @@
           Unary operator- for A
         
         
-          No way to generate a brief from the        operator kind because there are        unary and binary operators.
+          No way to generate a brief from the operator kind because there are unary and binary operators.
         
         
           Result
@@ -157,7 +157,7 @@
           Binary operator- for A
         
         
-          No way to generate a brief from the        operator kind.
+          No way to generate a brief from the operator kind.
         
         
           Result
@@ -262,7 +262,7 @@
         Function with same brief
       
       
-        Describe a again    
+        Describe a again
       
       
         Describe b
diff --git a/test-files/golden-tests/symbols/overloads/overloads-metadata.adoc b/test-files/golden-tests/symbols/overloads/overloads-metadata.adoc
index d2b1f86076..a250649ee5 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-metadata.adoc
+++ b/test-files/golden-tests/symbols/overloads/overloads-metadata.adoc
@@ -121,8 +121,6 @@ int
 
 
 * a must be greater than 0
-
-
 * b must be greater than 0
 
 
@@ -131,8 +129,6 @@ int
 
 
 * The return value is greater than 0
-
-
 * The return value is greater than 10
 
 
@@ -141,9 +137,6 @@ int
 
 
 Interesting information 1
-
-
-
 Interesting information 2
 
 
@@ -340,8 +333,6 @@ The number corresponding to a and b
 
 
 * a must be greater than 0
-
-
 * b must be greater than 0
 
 
diff --git a/test-files/golden-tests/symbols/overloads/overloads-metadata.html b/test-files/golden-tests/symbols/overloads/overloads-metadata.html
index a6274848c9..983c82e7f3 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-metadata.html
+++ b/test-files/golden-tests/symbols/overloads/overloads-metadata.html
@@ -19,8 +19,7 @@ 
    Functions
    
 
 
 
-f Test function
-
+f Test function
 
 
 
@@ -29,8 +28,7 @@ 
    Functions
    
 
    
 
    f
    
 
    
-Test function
-
+Test function
 
 
    
 
    
@@ -38,11 +36,7 @@ 
    f
    
 
    Synopses
    
 
    
 Declared in <overloads-metadata.cpp>
    
-
    
-    Test function
-
-
    
-
+
    Test function
    
 
 
     
@@ -52,11 +46,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Test function
-
-
    
-
+
    Test function
    
 
 
     
@@ -67,11 +57,7 @@ 
    Synopses
    
     
 
    » more...
 
-
    
-    Test function
-
-
    
-
+
    Test function
    
 
 
     
@@ -99,13 +85,11 @@ 
    Exceptions
    
 
 
 std::runtime_error
-
    Describe the exception
    
-
+Describe the exception
 
 
 std::logic_error
-
    Describe the exception
    
-
+Describe the exception
 
 
 
@@ -113,10 +97,8 @@ 
    Exceptions
    
 
    
 
    Return Value
    
 
      
-
    • The number corresponding to a
      
-
      • 
-
    • The number corresponding to a and b
      
-
      • 
+
    • The number corresponding to a
      • 
+
    • The number corresponding to a and b
      • 
 
    
 
    
 
    
@@ -131,13 +113,11 @@ 
    Template Parameters
    
 
 
 A
-
    Describe A
    
-
+Describe A
 
 
 B
-
    Describe B
    
-
+Describe B
 
 
 
@@ -154,13 +134,11 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 b
-
    Describe b
    
-
+Describe b
 
 
 
@@ -168,35 +146,28 @@ 
    Parameters
    
 
    
 
    Preconditions
    
 
      
-
    • a must be greater than 0
      
-
      • 
-
    • b must be greater than 0
      
-
      • 
+
    • a must be greater than 0
      • 
+
    • b must be greater than 0
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • The return value is greater than 0
      
-
      • 
-
    • The return value is greater than 10
      
-
      • 
+
    • The return value is greater than 0
      • 
+
    • The return value is greater than 10
      • 
 
    
 
    
 
    
 
    See Also
    
-
    Interesting information 1
    
-
    
-
    Interesting information 2
    
-
    
+
    Interesting information 1
    
+
    Interesting information 2
    
 
    
 
    
 
    
 
    
 
    f
    
 
    
-Test function
-
+Test function
 
 
    
 
    
@@ -224,16 +195,14 @@ 
    Exceptions
    
 
 
 std::runtime_error
-
    Describe the exception
    
-
+Describe the exception
 
 
 
 
    
 
    
 
    Return Value
    
-
    The number corresponding to a
    
-
+The number corresponding to a
 
    
 
    
 
    Template Parameters
    
@@ -247,8 +216,7 @@ 
    Template Parameters
    
 
 
 A
-
    Describe A
    
-
+Describe A
 
 
 
@@ -265,8 +233,7 @@ 
    Parameters
    
 
 
 a
-
    Describe a
    
-
+Describe a
 
 
 
@@ -274,29 +241,25 @@ 
    Parameters
    
 
    
 
    Preconditions
    
 
      
-
    • a must be greater than 0
      
-
      • 
+
    • a must be greater than 0
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • The return value is greater than 0
      
-
      • 
+
    • The return value is greater than 0
      • 
 
    
 
    
 
    
 
    See Also
    
-
    Interesting information 1
    
-
    
+
    Interesting information 1
    
 
    
 
    
 
    
 
    
 
    f
    
 
    
-Test function
-
+Test function
 
 
    
 
    
@@ -315,8 +278,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    The number corresponding to a
    
-
+The number corresponding to a
 
    
 
    
 
    Parameters
    
@@ -330,24 +292,21 @@ 
    Parameters
    
 
 
 a
-
    Describe a again
    
-
+Describe a again
 
 
 
 
    
 
    
 
    See Also
    
-
    Interesting information 2
    
-
    
+
    Interesting information 2
    
 
    
 
    
 
    
 
    
 
    f
    
 
    
-Test function
-
+Test function
 
 
    
 
    
@@ -379,16 +338,14 @@ 
    Exceptions
    
 
 
 std::logic_error
-
    Describe the exception
    
-
+Describe the exception
 
 
 
 
    
 
    
 
    Return Value
    
-
    The number corresponding to a and b
    
-
+The number corresponding to a and b
 
    
 
    
 
    Template Parameters
    
@@ -402,13 +359,11 @@ 
    Template Parameters
    
 
 
 A
-
    Describe A again
    
-
+Describe A again
 
 
 B
-
    Describe B
    
-
+Describe B
 
 
 
@@ -425,13 +380,11 @@ 
    Parameters
    
 
 
 a
-
    Describe a again
    
-
+Describe a again
 
 
 b
-
    Describe b
    
-
+Describe b
 
 
 
@@ -439,17 +392,14 @@ 
    Parameters
    
 
    
 
    Preconditions
    
 
      
-
    • a must be greater than 0
      
-
      • 
-
    • b must be greater than 0
      
-
      • 
+
    • a must be greater than 0
      • 
+
    • b must be greater than 0
      • 
 
    
 
    
 
    
 
    Postconditions
    
 
      
-
    • The return value is greater than 10
      
-
      • 
+
    • The return value is greater than 10
      • 
 
    
 
    
 
    
diff --git a/test-files/golden-tests/symbols/overloads/overloads-metadata.xml b/test-files/golden-tests/symbols/overloads/overloads-metadata.xml
index 2582462928..0a74aef779 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-metadata.xml
+++ b/test-files/golden-tests/symbols/overloads/overloads-metadata.xml
@@ -20,10 +20,10 @@
           The number corresponding to a
         
         
-          Describe a    
+          Describe a
         
         
-          Describe A    
+          Describe A
         
         
           Describe the exception
@@ -32,7 +32,7 @@
           Interesting information 1
         
         
    -          a must be greater than 0    
+          a must be greater than 0
         
    
         
           The return value is greater than 0
@@ -61,7 +61,7 @@
         The number corresponding to a
       
       
-        Describe a again    
+        Describe a again
       
       
         Interesting information 2
@@ -90,25 +90,25 @@
           The number corresponding to a and b
         
         
-          Describe a again    
+          Describe a again
         
         
-          Describe b    
+          Describe b
         
         
-          Describe A again    
+          Describe A again
         
         
-          Describe B    
+          Describe B
         
         
           Describe the exception
         
         
    -          a must be greater than 0    
+          a must be greater than 0
         
    
         
    -          b must be greater than 0    
+          b must be greater than 0
         
    
         
           The return value is greater than 10
diff --git a/test-files/golden-tests/symbols/overloads/overloads-ostream.html b/test-files/golden-tests/symbols/overloads/overloads-ostream.html
index beff507af1..96c1b21061 100644
--- a/test-files/golden-tests/symbols/overloads/overloads-ostream.html
+++ b/test-files/golden-tests/symbols/overloads/overloads-ostream.html
@@ -80,7 +80,7 @@ 
    Member Functions
    
 
 
 
-operator<< 
+operator<< 
 
 
 
@@ -197,7 +197,7 @@ 
    Functions
    
 
 
 
-operator<< 
+operator<< 
 
 
 
diff --git a/test-files/golden-tests/symbols/overloads/overloads.html b/test-files/golden-tests/symbols/overloads/overloads.html
index 8be428f10e..dc2aedec86 100644
--- a/test-files/golden-tests/symbols/overloads/overloads.html
+++ b/test-files/golden-tests/symbols/overloads/overloads.html
@@ -34,9 +34,9 @@ 
    Functions
    
 
 
 
-f 
+f 
 
-operator== 
+operator== 
 
 
 
@@ -65,7 +65,7 @@ 
    Member Functions
    
 
 
 
-f 
+f 
 
 
 
@@ -79,7 +79,7 @@ 
    Static Member Functions
    
 
 
 
-g 
+g 
 
 
 
diff --git a/test-files/golden-tests/symbols/record/record-1.html b/test-files/golden-tests/symbols/record/record-1.html
index 1cac6acb30..5db991d27c 100644
--- a/test-files/golden-tests/symbols/record/record-1.html
+++ b/test-files/golden-tests/symbols/record/record-1.html
@@ -80,14 +80,11 @@ 
    Protected Member Functions
    
 
 
 
-g1 brief-g1
-
+g1 brief-g1
 
-g2 brief-g2
-
+g2 brief-g2
 
-g3 brief-g3
-
+g3 brief-g3
 
 
 
@@ -175,8 +172,7 @@ 
    Synopsis
    
 
    
 
    T::g1
    
 
    
-brief-g1
-
+brief-g1
 
 
    
 
    
@@ -193,17 +189,14 @@ 
    Synopsis
    
 
 
    
 
    Description
    
-
    desc
    
-
-
+
    desc
    
 
    
 
 
    
 
    
 
    T::g2
    
 
    
-brief-g2
-
+brief-g2
 
 
    
 
    
@@ -220,16 +213,14 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    the number 2
    
-
+the number 2
 
    
 
 
    
 
    
 
    T::g3
    
 
    
-brief-g3
-
+brief-g3
 
 
    
 
    
@@ -246,8 +237,7 @@ 
    Synopsis
    
 
    
 
    
 
    Return Value
    
-
    the separator
    
-
+the separator
 
    
 
    
 
    Parameters
    
@@ -261,8 +251,7 @@ 
    Parameters
    
 
 
 x
-
    any old number
    
-
+any old number
 
 
 
diff --git a/test-files/golden-tests/symbols/using/using-3.html b/test-files/golden-tests/symbols/using/using-3.html
index a8e7e3ec3c..148022394b 100644
--- a/test-files/golden-tests/symbols/using/using-3.html
+++ b/test-files/golden-tests/symbols/using/using-3.html
@@ -145,7 +145,7 @@ 
    Member Functions
    
 
 
 
-f 
+f 
 
 
 
diff --git a/test-files/golden-tests/templates/c_mft_expl_inline.html b/test-files/golden-tests/templates/c_mft_expl_inline.html
index 0b4a16e5af..cf51919b11 100644
--- a/test-files/golden-tests/templates/c_mft_expl_inline.html
+++ b/test-files/golden-tests/templates/c_mft_expl_inline.html
@@ -47,7 +47,7 @@ 
    Member Functions
    
 
 
 
-f 
+f 
 
 
 
diff --git a/test-files/golden-tests/templates/c_mft_expl_outside.html b/test-files/golden-tests/templates/c_mft_expl_outside.html
index 7cdd10205e..ad17d2c8bb 100644
--- a/test-files/golden-tests/templates/c_mft_expl_outside.html
+++ b/test-files/golden-tests/templates/c_mft_expl_outside.html
@@ -47,7 +47,7 @@ 
    Member Functions
    
 
 
 
-f 
+f 
 
 
 
diff --git a/test-files/golden-tests/templates/ct_mft_expl_inline.html b/test-files/golden-tests/templates/ct_mft_expl_inline.html
index ee57b6da90..d6a09d1307 100644
--- a/test-files/golden-tests/templates/ct_mft_expl_inline.html
+++ b/test-files/golden-tests/templates/ct_mft_expl_inline.html
@@ -48,7 +48,7 @@ 
    Member Functions
    
 
 
 
-f 
+f 
 
 
 
diff --git a/test-files/golden-tests/templates/ct_mft_expl_outside.html b/test-files/golden-tests/templates/ct_mft_expl_outside.html
index 59ec88d2e4..b88bc3a5f8 100644
--- a/test-files/golden-tests/templates/ct_mft_expl_outside.html
+++ b/test-files/golden-tests/templates/ct_mft_expl_outside.html
@@ -98,7 +98,7 @@ 
    Member Functions
    
 
 
 
-f 
+f 
 
 
 
diff --git a/test-files/golden-tests/templates/ft_expl.html b/test-files/golden-tests/templates/ft_expl.html
index 57828338e3..2cafcee7d3 100644
--- a/test-files/golden-tests/templates/ft_expl.html
+++ b/test-files/golden-tests/templates/ft_expl.html
@@ -19,7 +19,7 @@ 
    Functions
    
 
 
 
-f 
+f