From ba7a6adb8932e57616547bc76acb70c2d1d45d6d Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Thu, 16 Jan 2025 12:56:35 -0300 Subject: [PATCH] promote auto brief paragraph types #fix fix #803 --- include/mrdocs/Metadata/Javadoc.hpp | 12 +- include/mrdocs/Support/Error.hpp | 8 +- mrdocs.rnc | 4 +- .../symbol/detail/members-table-row.hbs | 1 + src/lib/AST/ASTVisitor.cpp | 10 +- src/lib/Gen/adoc/DocVisitor.cpp | 18 +- src/lib/Gen/hbs/HandlebarsCorpus.cpp | 14 +- src/lib/Gen/html/DocVisitor.cpp | 35 ++-- src/lib/Metadata/Javadoc.cpp | 138 ++++++------- src/lib/Support/Error.cpp | 6 + src/test/TestRunner.cpp | 10 +- test-files/golden-tests/core/libcxx.adoc | 4 - test-files/golden-tests/core/libcxx.html | 4 +- .../filters/symbol-name/extraction-mode.adoc | 100 ---------- .../filters/symbol-name/extraction-mode.html | 100 +++++----- test-files/golden-tests/javadoc/brief-1.adoc | 12 +- test-files/golden-tests/javadoc/brief-1.cpp | 2 +- test-files/golden-tests/javadoc/brief-1.html | 8 +- test-files/golden-tests/javadoc/brief-1.xml | 2 +- test-files/golden-tests/javadoc/brief-2.adoc | 24 --- test-files/golden-tests/javadoc/brief-2.html | 24 +-- test-files/golden-tests/javadoc/brief-3.adoc | 156 +++++++++++++++ test-files/golden-tests/javadoc/brief-3.cpp | 17 ++ test-files/golden-tests/javadoc/brief-3.html | 183 ++++++++++++++++++ test-files/golden-tests/javadoc/brief-3.xml | 60 ++++++ test-files/golden-tests/javadoc/code.adoc | 4 - test-files/golden-tests/javadoc/code.html | 4 +- test-files/golden-tests/javadoc/commands.adoc | 4 - test-files/golden-tests/javadoc/commands.html | 4 +- .../golden-tests/javadoc/duplicate-jdoc.adoc | 24 --- .../golden-tests/javadoc/duplicate-jdoc.html | 24 +-- test-files/golden-tests/javadoc/par-1.adoc | 16 -- test-files/golden-tests/javadoc/par-1.html | 16 +- test-files/golden-tests/javadoc/para-1.adoc | 4 - test-files/golden-tests/javadoc/para-1.html | 4 +- test-files/golden-tests/javadoc/para-2.adoc | 4 - test-files/golden-tests/javadoc/para-2.html | 4 +- test-files/golden-tests/javadoc/para-3.html | 2 + test-files/golden-tests/javadoc/ref.adoc | 20 -- test-files/golden-tests/javadoc/ref.html | 20 +- test-files/golden-tests/javadoc/styled.adoc | 8 - test-files/golden-tests/javadoc/styled.html | 8 +- test-files/golden-tests/javadoc/throw.adoc | 4 - test-files/golden-tests/javadoc/throw.html | 4 +- test-files/golden-tests/metadata/enum.adoc | 16 -- test-files/golden-tests/metadata/enum.html | 16 +- .../golden-tests/metadata/friend-1.adoc | 8 - .../golden-tests/metadata/friend-1.html | 8 +- .../golden-tests/metadata/friend-2.adoc | 8 - .../golden-tests/metadata/friend-2.html | 8 +- .../golden-tests/metadata/friend-3.adoc | 8 - .../golden-tests/metadata/friend-3.html | 8 +- .../golden-tests/metadata/friend-4.adoc | 8 - .../golden-tests/metadata/friend-4.html | 8 +- .../golden-tests/metadata/friend-5.adoc | 4 - .../golden-tests/metadata/friend-5.html | 4 +- .../golden-tests/metadata/friend-6.adoc | 28 --- .../golden-tests/metadata/friend-6.html | 28 +-- .../golden-tests/metadata/record-1.adoc | 12 -- .../golden-tests/metadata/record-1.html | 12 +- test-files/golden-tests/metadata/sfinae.adoc | 48 ----- test-files/golden-tests/metadata/sfinae.html | 48 ++--- .../golden-tests/snippets/distance.adoc | 4 - .../golden-tests/snippets/distance.html | 4 +- .../golden-tests/snippets/is_prime.adoc | 4 - .../golden-tests/snippets/is_prime.html | 4 +- test-files/golden-tests/snippets/sqrt.adoc | 4 - test-files/golden-tests/snippets/sqrt.html | 4 +- .../golden-tests/snippets/terminate.adoc | 4 - .../golden-tests/snippets/terminate.html | 4 +- 70 files changed, 762 insertions(+), 680 deletions(-) create mode 100644 test-files/golden-tests/javadoc/brief-3.adoc create mode 100644 test-files/golden-tests/javadoc/brief-3.cpp create mode 100644 test-files/golden-tests/javadoc/brief-3.html create mode 100644 test-files/golden-tests/javadoc/brief-3.xml diff --git a/include/mrdocs/Metadata/Javadoc.hpp b/include/mrdocs/Metadata/Javadoc.hpp index 43da81c9e4..bd64a50c0b 100644 --- a/include/mrdocs/Metadata/Javadoc.hpp +++ b/include/mrdocs/Metadata/Javadoc.hpp @@ -385,8 +385,10 @@ struct MRDOCS_DECL bool operator==(const Block& other) const noexcept { - if(kind != other.kind) + if (kind != other.kind) + { return false; + } return std::equal(children.begin(), children.end(), other.children.begin(), other.children.end(), [](const auto& a, const auto& b) @@ -410,6 +412,8 @@ struct MRDOCS_DECL void append(List&& blocks); + void append(List const& otherChildren); + protected: explicit Block( @@ -892,7 +896,7 @@ void traverse( struct Overview { - Paragraph const* brief = nullptr; + std::shared_ptr brief = nullptr; std::vector blocks; Returns const* returns = nullptr; std::vector params; @@ -916,6 +920,8 @@ class Corpus; class MRDOCS_DECL Javadoc { + doc::List blocks_; + public: /** Constructor. */ @@ -1015,8 +1021,6 @@ class MRDOCS_DECL private: std::string emplace_back(std::unique_ptr); - - doc::List blocks_; }; /** Return the Javadoc as a @ref dom::Value. diff --git a/include/mrdocs/Support/Error.hpp b/include/mrdocs/Support/Error.hpp index 3b99ba7dee..65450e4bae 100644 --- a/include/mrdocs/Support/Error.hpp +++ b/include/mrdocs/Support/Error.hpp @@ -2702,6 +2702,10 @@ void setMinimumLevel( Level level) noexcept; +MRDOCS_DECL +Level +getMinimumLevel() noexcept; + /** If true, source location information will be printed with warnings, errors, and fatal messages. */ @@ -2787,9 +2791,11 @@ log_impl( Level level, Located fs) { + std::string str = fmt::vformat( + fs.value, fmt::make_format_args()); return print( level, - {}, + str, &fs.where); } } diff --git a/mrdocs.rnc b/mrdocs.rnc index 4ebb5468c6..74256dbac3 100644 --- a/mrdocs.rnc +++ b/mrdocs.rnc @@ -387,7 +387,7 @@ grammar BlockNode = ( Admonition | Brief | Code | Heading | ListItem | Paragraph | Param | Returns | TParam | Throws | - See | Precondition | Postcondition) + See | Precondition | Postcondition | Details) Admonition = Paragraph Brief = element brief { TextNode * } @@ -411,7 +411,7 @@ grammar TextNode * } Precondition = element pre { TextNode * } Postcondition = element post { TextNode * } - + Details = element details { TextNode * } TextNode = ( Link | Styled | Text | Reference | Copied ) 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 7c8bfcf716..12c4f1fe1a 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 @@ -11,6 +11,7 @@ {{else~}} {{#each (unique (pluck (pluck members "doc") "brief"))~}} {{{.}}} + {{/each~}} {{/if~}} {{~/markup/td~}} diff --git a/src/lib/AST/ASTVisitor.cpp b/src/lib/AST/ASTVisitor.cpp index 5eb54512b8..6fafebaa41 100644 --- a/src/lib/AST/ASTVisitor.cpp +++ b/src/lib/AST/ASTVisitor.cpp @@ -1774,16 +1774,10 @@ generateJavadoc( { RawComment const* RC = D->getASTContext().getRawCommentForDeclNoCache(D); - if (!RC) - { - return false; - } + MRDOCS_CHECK_OR(RC, false); comments::FullComment* FC = RC->parse(D->getASTContext(), &sema_.getPreprocessor(), D); - if (!FC) - { - return false; - } + MRDOCS_CHECK_OR(FC, false); parseJavadoc(javadoc, FC, D, config_, diags_); return true; } diff --git a/src/lib/Gen/adoc/DocVisitor.cpp b/src/lib/Gen/adoc/DocVisitor.cpp index 0916eb302e..00f601c8c3 100644 --- a/src/lib/Gen/adoc/DocVisitor.cpp +++ b/src/lib/Gen/adoc/DocVisitor.cpp @@ -93,7 +93,6 @@ operator()( fmt::format_to(ins_, "\n=== {}\n\n", AdocEscape(I.string)); } -// Also handles doc::Brief void DocVisitor:: operator()( @@ -135,14 +134,21 @@ operator()( { return; } - bool non_empty = write(*children.front(), *this); - for(auto const& child : children.subspan(1)) + + std::size_t i = 0; + for (auto it = children.begin(); it != children.end(); ++it) { - if (non_empty) + auto& child = *it; + if (i == 0) { - dest_.push_back('\n'); + child->string = ltrim(child->string); } - non_empty = write(*child, *this); + if (i == children.size() - 1) + { + child->string = rtrim(child->string); + } + write(*child, *this); + i = i + 1; } } diff --git a/src/lib/Gen/hbs/HandlebarsCorpus.cpp b/src/lib/Gen/hbs/HandlebarsCorpus.cpp index df0a46d576..827e67af35 100644 --- a/src/lib/Gen/hbs/HandlebarsCorpus.cpp +++ b/src/lib/Gen/hbs/HandlebarsCorpus.cpp @@ -197,12 +197,10 @@ getJavadoc(Javadoc const& jd) const When the string is empty, the object key is undefined. */ - auto emplaceString = [&]( - std::string_view key, - auto const& I) + auto emplaceString = [&]( + std::string_view key, T const& I) { std::string s; - using T = std::decay_t; if constexpr (std::derived_from) { // doc::visit(*t, visitor); @@ -232,13 +230,17 @@ getJavadoc(Javadoc const& jd) const elements.reserve(nodes.size()); for(auto const& elem : nodes) { - if(!elem) + if (!elem) + { continue; + } elements.emplace_back( domCreate(*elem, *this)); } - if(elements.empty()) + if (elements.empty()) + { return; + } objKeyValues.emplace_back(key, dom::newArray< dom::DefaultArrayImpl>(std::move(elements))); }; diff --git a/src/lib/Gen/html/DocVisitor.cpp b/src/lib/Gen/html/DocVisitor.cpp index af89757159..547dd8d759 100644 --- a/src/lib/Gen/html/DocVisitor.cpp +++ b/src/lib/Gen/html/DocVisitor.cpp @@ -139,25 +139,38 @@ DocVisitor:: operator()( doc::Brief const& I) const { + if (I.children.empty()) + { + return; + } + dest_.append(""); - for(auto const& it : RangeFor(I.children)) + std::size_t i = 0; + for (auto it = I.children.begin(); it != I.children.end(); ++it) { - auto const n = dest_.size(); - doc::visit(*it.value, *this); - // detect empty text blocks - if(! it.last && dest_.size() > n) + auto& child = *it; + if (i == 0) { - // wrap past 80 cols - if (dest_.size() < 80) + child->string = ltrim(child->string); + } + else if (auto prevIt = std::prev(it); + !(*prevIt)->string.empty() && !child->string.empty()) + { + char const pc = (*(prevIt))->string.back(); + char const cc = child->string.front(); + if (!std::isspace(pc) && !std::isspace(cc)) { dest_.push_back(' '); - } else - { - dest_.push_back('\n'); } } + if (i == I.children.size() - 1) + { + child->string = rtrim(child->string); + } + write(*child, *this); + i = i + 1; } - dest_.append(""); + dest_.append("\n"); } void diff --git a/src/lib/Metadata/Javadoc.cpp b/src/lib/Metadata/Javadoc.cpp index 9e0e116382..b8d386f822 100644 --- a/src/lib/Metadata/Javadoc.cpp +++ b/src/lib/Metadata/Javadoc.cpp @@ -41,63 +41,41 @@ append(List&& blocks) { MRDOCS_ASSERT(block->isText()); emplace_back(std::unique_ptr( - static_cast(block.release()))); + dynamic_cast(block.release()))); } } -#if 0 -static -Overview -makeOverview( - Block* brief, - List const& list) +void +Block:: +append(List const& otherChildren) { - doc::Overview ov; - - // VFALCO dupes should already be reported as - // warnings or errors by now so we don't have - // to care about it here. - - for(auto it = list.begin(); - it != list.end(); ++it) + children.reserve(children.size() + otherChildren.size()); + for(auto const& otherChildPtr : otherChildren) { - switch((*it)->kind) - { - case Kind::brief: - // ov.brief = static_cast< - // Paragraph const*>(it->get()); - break; - case Kind::returns: - ov.returns = static_cast< - Returns const*>(it->get()); - break; - case Kind::param: - ov.params.push_back(static_cast< - Param const*>(it->get())); - break; - case Kind::tparam: - ov.tparams.push_back(static_cast< - TParam const*>(it->get())); - break; - #if 0 - case Kind::paragraph: - if(! ov.brief) - ov.brief = static_cast< - Paragraph const*>(it->get()); - else - ov.blocks.push_back(it->get()); - break; - #endif - default: - if(ov.brief == it->get()) - break; - ov.blocks.push_back(it->get()); - } + Text const& otherChild = *otherChildPtr; + visit(otherChild, [this](U const& otherChildU) { + if constexpr (std::derived_from) + { + U otherChildCopy; + otherChildCopy.string = otherChildU.string; + if constexpr (std::derived_from) + { + otherChildCopy.style = otherChildU.style; + } + if constexpr (std::derived_from) + { + otherChildCopy.href = otherChildU.href; + } + if constexpr (std::derived_from) + { + otherChildCopy.id = otherChildU.id; + } + auto otherChildCopyPtr = std::make_unique(std::move(otherChildCopy)); + children.push_back(std::move(otherChildCopyPtr)); + } + }); } - - return ov; } -#endif dom::String toString( @@ -153,43 +131,62 @@ doc::Paragraph const* Javadoc:: getBrief(Corpus const& corpus) const noexcept { + // Brief from a @brief tag const doc::Block* brief = nullptr; + // The first paragraph promoted to brief const doc::Block* promoted_brief = nullptr; + // A brief copied from another symbol const doc::Block* copied_brief = nullptr; for(auto const& block : blocks_) { - if(! brief && - block->kind == doc::Kind::brief) + if (!brief && block->kind == doc::Kind::brief) + { brief = block.get(); - if(! promoted_brief && - block->kind == doc::Kind::paragraph) + } + if (!promoted_brief && block->kind == doc::Kind::paragraph) + { promoted_brief = block.get(); + } // if we already have an explicit/copied brief, // don't check for additional copied briefs - if(brief || copied_brief) + if (brief || copied_brief) + { continue; + } - for(auto const& text : block->children) + // Look for a @copydoc command + for (auto const& text : block->children) { - if(text->kind != doc::Kind::copied) + if (text->kind != doc::Kind::copied) + { continue; - auto* copy = static_cast(text.get()); + } + auto const* copy = dynamic_cast(text.get()); if(copy->id && (copy->parts == doc::Parts::all || copy->parts == doc::Parts::brief)) { - if(auto& jd = corpus.get(copy->id).javadoc) + // Look for the symbol to copy from + if (auto& jd = corpus.get(copy->id).javadoc) + { copied_brief = jd->getBrief(corpus); + } } } } - // an explicit brief superceeds a copied brief - if(! brief) + // An explicit brief superceeds a copied brief + if (!brief) + { + // No explicit brief: use copied brief brief = copied_brief; - // a copied brief superceeds a promoted brief - if(! brief) + } + // A copied brief superceeds a promoted brief + if (!brief) + { + // No copied brief: use promoted brief brief = promoted_brief; + } return static_cast(brief); } @@ -242,9 +239,16 @@ Javadoc:: makeOverview( const Corpus& corpus) const { - // return doc::makeOverview(blocks_); doc::Overview ov; - ov.brief = getBrief(corpus); + doc::Paragraph const* briefP = getBrief(corpus); + if (briefP) + { + // Brief can be a brief or paragraph (if it was promoted) + // Ensure it's always a brief so that they are all + // rendered the same way. + ov.brief = std::make_shared(); + ov.brief->append(briefP->children); + } const auto& list = getDescription(corpus); // VFALCO dupes should already be reported as @@ -288,8 +292,10 @@ makeOverview( doc::Postcondition const*>(it->get())); break; default: - if(ov.brief == it->get()) + if (briefP == it->get()) + { break; + } ov.blocks.push_back(it->get()); } } diff --git a/src/lib/Support/Error.cpp b/src/lib/Support/Error.cpp index c950e8f939..7a0c3dc593 100644 --- a/src/lib/Support/Error.cpp +++ b/src/lib/Support/Error.cpp @@ -192,6 +192,12 @@ setMinimumLevel( level_ = level; } +Level +getMinimumLevel() noexcept +{ + return level_; +} + void setSourceLocationWarnings(bool b) noexcept { diff --git a/src/test/TestRunner.cpp b/src/test/TestRunner.cpp index 42a9c42c07..a57617663c 100644 --- a/src/test/TestRunner.cpp +++ b/src/test/TestRunner.cpp @@ -70,6 +70,8 @@ handleFile( llvm::StringRef filePath, Config::Settings const& dirSettings) { + report::debug("Handling {}", filePath); + namespace fs = llvm::sys::fs; namespace path = llvm::sys::path; @@ -87,6 +89,7 @@ handleFile( } // File-specific config + report::debug("Loading Config"); Config::Settings fileSettings = dirSettings; auto configPath = files::withExtension(filePath, "yml"); if (files::exists(configPath)) { @@ -114,16 +117,18 @@ handleFile( MrDocsCompilationDatabase compilations( llvm::StringRef(parentDir), SingleFileDB(filePath), config, defaultIncludePaths); + report::debug("Building Corpus", filePath); + auto prev = report::getMinimumLevel(); report::setMinimumLevel(report::Level::error); - - // Build Corpus auto corpus = CorpusImpl::build(config, compilations); + report::setMinimumLevel(prev); if (!corpus) { return report::error("{}: \"{}\"", corpus.error(), filePath); } // Generate + report::debug("Generating documentation", filePath); std::string generatedDocs; if (auto exp = gen_->buildOneString(generatedDocs, **corpus); !exp) { @@ -134,6 +139,7 @@ handleFile( // Generate tagfile if (auto hbsGen = dynamic_cast(gen_)) { + report::debug("Generating tagfile", filePath); std::stringstream ss; if (auto exp = hbsGen->buildTagfile(ss, **corpus); !exp) { diff --git a/test-files/golden-tests/core/libcxx.adoc b/test-files/golden-tests/core/libcxx.adoc index 29e6e9d4d2..4b3178f4be 100644 --- a/test-files/golden-tests/core/libcxx.adoc +++ b/test-files/golden-tests/core/libcxx.adoc @@ -14,8 +14,6 @@ | <> | Computes the square root of an integral value. - - |=== [#sqrt] @@ -24,8 +22,6 @@ Computes the square root of an integral value. - - === Synopsis diff --git a/test-files/golden-tests/core/libcxx.html b/test-files/golden-tests/core/libcxx.html index c9e8446a3d..a2f4bce734 100644 --- a/test-files/golden-tests/core/libcxx.html +++ b/test-files/golden-tests/core/libcxx.html @@ -18,7 +18,7 @@

Functions

-sqrt

Computes the square root of an integral value.

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

Functions

sqrt

-

Computes the square root of an integral value.

+Computes the square root of an integral value.
diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc b/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc index a5c96028c8..36b45d810b 100644 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc +++ b/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc @@ -14,13 +14,9 @@ | <> | A regular namespace with different filters for members - - | <> | A see‐below namespace - - |=== === Namespace Aliases @@ -31,18 +27,12 @@ | <> | Namespace alias to form the dependency on dependency_ns - - | <> | Namespace alias to form a dependency on the implementation‐defined namespace - - | <> | Namespace alias to form a dependency on the see‐below namespace - - |=== === Types @@ -53,13 +43,9 @@ | <> | A regular symbol in the global namespace - - | <> | A see‐below symbol in the global namespace - - |=== === Functions @@ -70,23 +56,15 @@ | <> | A function to get a dependency symbol on the global namespace - - | <> | A function to get an implementation‐defined symbol in the global namespace - - | <> | A function to get a regular symbol in the global namespace - - | <> | A function to get a see‐below symbol in the global namespace - - |=== [#regular_ns] @@ -95,8 +73,6 @@ A regular namespace with different filters for members - - === Types [cols=2] @@ -106,13 +82,9 @@ A regular namespace with different filters for members | <> | A symbol that passes the filters - - | <> | A symbol that passes the see‐below filter - - |=== === Functions @@ -123,23 +95,15 @@ A regular namespace with different filters for members | <> | A function to get an excluded symbol - - | <> | A function to get an implementation‐defined symbol - - | <> | A function to get a regular symbol - - | <> | A function to get a see‐below symbol - - |=== [#regular_ns-regular] @@ -148,8 +112,6 @@ A regular namespace with different filters for members A symbol that passes the filters - - === Synopsis @@ -169,8 +131,6 @@ struct regular; | <> | Child of a regular symbol extracted as regular - - |=== @@ -188,8 +148,6 @@ The symbol should have a page as usual Child of a regular symbol extracted as regular - - === Synopsis @@ -209,8 +167,6 @@ struct also_regular; | <> | Grandchild of a regular symbol extracted as regular - - |=== @@ -221,8 +177,6 @@ struct also_regular; Grandchild of a regular symbol extracted as regular - - === Synopsis @@ -242,8 +196,6 @@ struct regular_as_well; A symbol that passes the see‐below filter - - === Synopsis @@ -270,8 +222,6 @@ A symbol that passes the filters and the see‐below filter. The sym A function to get an excluded symbol - - === Synopsis @@ -296,8 +246,6 @@ When used in a function, only the symbol name should be shown. No links s A function to get an implementation‐defined symbol - - === Synopsis @@ -324,8 +272,6 @@ It's the responsibility of the function documentation to explain the implem A function to get a regular symbol - - === Synopsis @@ -350,8 +296,6 @@ When used in a function, the symbol should be shown as usual with a link to the A function to get a see‐below symbol - - === Synopsis @@ -376,8 +320,6 @@ When used in a function, the symbol name should be shown as usual. The pa A see‐below namespace - - === Types [cols=2] @@ -387,13 +329,9 @@ A see‐below namespace | <> | Regular symbol in a see‐below namespace - - | <> | See‐below symbol in a see‐below namespace - - |=== === Functions @@ -404,13 +342,9 @@ A see‐below namespace | <> | A function to get a dependency symbol in a see‐below namespace - - | <> | A function to get an implementation‐defined symbol in a see‐below namespace - - |=== === Description @@ -428,8 +362,6 @@ The documentation page for these symbols should include the see‐below com Regular symbol in a see‐below namespace - - === Synopsis @@ -456,8 +388,6 @@ The symbol becomes see‐below because the whole namespace is see‐be See‐below symbol in a see‐below namespace - - === Synopsis @@ -484,8 +414,6 @@ The symbol becomes see‐below because the whole namespace is see‐be A function to get a dependency symbol in a see‐below namespace - - === Synopsis @@ -512,8 +440,6 @@ It's the responsibility of the function documentation to explain the depend A function to get an implementation‐defined symbol in a see‐below namespace - - === Synopsis @@ -540,8 +466,6 @@ It's the responsibility of the function documentation to explain the implem A regular symbol in the global namespace - - === Synopsis @@ -561,8 +485,6 @@ struct regular; | <> | Child of a regular symbol: should be traversed as usual - - |=== @@ -580,8 +502,6 @@ This symbol should have a page as usual. Child of a regular symbol: should be traversed as usual - - === Synopsis @@ -601,8 +521,6 @@ struct also_regular; | <> | Grandchild of a regular symbol: should be traversed as usual - - |=== @@ -613,8 +531,6 @@ struct also_regular; Grandchild of a regular symbol: should be traversed as usual - - === Synopsis @@ -634,8 +550,6 @@ struct regular_as_well; A see‐below symbol in the global namespace - - === Synopsis @@ -664,8 +578,6 @@ The synopsis should say "See below". A function to get a dependency symbol on the global namespace - - === Synopsis @@ -690,8 +602,6 @@ The symbol should be extracted as a dependency but its members should not be tra A function to get an implementation‐defined symbol in the global namespace - - === Synopsis @@ -718,8 +628,6 @@ It's the responsibility of the function documentation to explain the implem A function to get a regular symbol in the global namespace - - === Synopsis @@ -744,8 +652,6 @@ When used in a function, the symbol should be shown as usual with a link to the A function to get a see‐below symbol in the global namespace - - === Synopsis @@ -770,8 +676,6 @@ When used in a function, the symbol name should be shown as usual. The pa Namespace alias to form the dependency on dependency_ns - - === Synopsis @@ -788,8 +692,6 @@ namespace dependency_ns_alias = dependency_ns; Namespace alias to form a dependency on the implementation‐defined namespace - - === Synopsis @@ -806,8 +708,6 @@ namespace implementation_defined_ns_alias = /* impl Namespace alias to form a dependency on the see‐below namespace - - === Synopsis 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 082ee49ad3..9b922a2638 100644 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.html +++ b/test-files/golden-tests/filters/symbol-name/extraction-mode.html @@ -18,10 +18,10 @@

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 @@ -35,13 +35,13 @@

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 @@ -55,10 +55,10 @@

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 @@ -72,16 +72,16 @@

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 @@ -91,7 +91,7 @@

Functions

regular_ns

-

A regular namespace with different filters for members

+A regular namespace with different filters for members
@@ -105,10 +105,10 @@

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 @@ -122,16 +122,16 @@

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 @@ -141,7 +141,7 @@

Functions

regular_ns::regular

-

A symbol that passes the filters

+A symbol that passes the filters
@@ -165,7 +165,7 @@

Types

-also_regular

Child of a regular symbol extracted as regular

+also_regular Child of a regular symbol extracted as regular @@ -183,7 +183,7 @@

Description

regular_ns::regular::also_regular

-

Child of a regular symbol extracted as regular

+Child of a regular symbol extracted as regular
@@ -207,7 +207,7 @@

Types

-regular_as_well

Grandchild of a regular symbol extracted as regular

+regular_as_well Grandchild of a regular symbol extracted as regular @@ -219,7 +219,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
@@ -241,7 +241,7 @@

Synopsis

regular_ns::see_below

-

A symbol that passes the see-below filter

+A symbol that passes the see-below filter
@@ -269,7 +269,7 @@

Description

regular_ns::get_dependency

-

A function to get an excluded symbol

+A function to get an excluded symbol
@@ -296,7 +296,7 @@

Description

regular_ns::get_implementation_defined

-

A function to get an implementation-defined symbol

+A function to get an implementation-defined symbol
@@ -324,7 +324,7 @@

Description

regular_ns::get_regular

-

A function to get a regular symbol

+A function to get a regular symbol
@@ -351,7 +351,7 @@

Description

regular_ns::get_see_below

-

A function to get a see-below symbol

+A function to get a see-below symbol
@@ -378,7 +378,7 @@

Description

see_below_ns

-

A see-below namespace

+A see-below namespace
@@ -392,10 +392,10 @@

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 @@ -409,10 +409,10 @@

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 @@ -429,7 +429,7 @@

Description

see_below_ns::regular

-

Regular symbol in a see-below namespace

+Regular symbol in a see-below namespace
@@ -457,7 +457,7 @@

Description

see_below_ns::see_below

-

See-below symbol in a see-below namespace

+See-below symbol in a see-below namespace
@@ -485,7 +485,7 @@

Description

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,7 +513,7 @@

Description

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,7 +541,7 @@

Description

regular

-

A regular symbol in the global namespace

+A regular symbol in the global namespace
@@ -565,7 +565,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 @@ -583,7 +583,7 @@

Description

regular::also_regular

-

Child of a regular symbol: should be traversed as usual

+Child of a regular symbol: should be traversed as usual
@@ -607,7 +607,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 @@ -619,7 +619,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
@@ -641,7 +641,7 @@

Synopsis

see_below

-

A see-below symbol in the global namespace

+A see-below symbol in the global namespace
@@ -670,7 +670,7 @@

Description

get_dependency

-

A function to get a dependency symbol on the global namespace

+A function to get a dependency symbol on the global namespace
@@ -697,7 +697,7 @@

Description

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
@@ -725,7 +725,7 @@

Description

get_regular

-

A function to get a regular symbol in the global namespace

+A function to get a regular symbol in the global namespace
@@ -752,7 +752,7 @@

Description

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
@@ -779,7 +779,7 @@

Description

dependency_ns_alias

-

Namespace alias to form the dependency on dependency_ns

+Namespace alias to form the dependency on dependency_ns
@@ -799,7 +799,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
@@ -819,7 +819,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
diff --git a/test-files/golden-tests/javadoc/brief-1.adoc b/test-files/golden-tests/javadoc/brief-1.adoc index de01d9aa12..cce5a478af 100644 --- a/test-files/golden-tests/javadoc/brief-1.adoc +++ b/test-files/golden-tests/javadoc/brief-1.adoc @@ -12,24 +12,18 @@ | Name | Description | <> -| brief *bold* itcontinues to the line. - - +| brief *bold* it continues to the line. | <> | brief - - |=== [#f5] == f5 -brief *bold* itcontinues to the line. - - +brief *bold* it continues to the line. === Synopsis @@ -48,8 +42,6 @@ f5(); brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/brief-1.cpp b/test-files/golden-tests/javadoc/brief-1.cpp index 2b998d9f8b..38ed82b528 100644 --- a/test-files/golden-tests/javadoc/brief-1.cpp +++ b/test-files/golden-tests/javadoc/brief-1.cpp @@ -25,7 +25,7 @@ void f4(); #endif /** brief @b bold it -continues to the line. + continues to the line. */ void f5(); diff --git a/test-files/golden-tests/javadoc/brief-1.html b/test-files/golden-tests/javadoc/brief-1.html index 4583438afe..0d7d1251fa 100644 --- a/test-files/golden-tests/javadoc/brief-1.html +++ b/test-files/golden-tests/javadoc/brief-1.html @@ -18,10 +18,10 @@

Functions

-f5

brief bold itcontinues to the line.

+f5 brief bold it continues to the line. -f6

brief

+f6 brief @@ -31,7 +31,7 @@

Functions

f5

-

brief bold itcontinues to the line.

+brief bold it continues to the line.
@@ -52,7 +52,7 @@

Synopsis

f6

-

brief

+brief
diff --git a/test-files/golden-tests/javadoc/brief-1.xml b/test-files/golden-tests/javadoc/brief-1.xml index f688679262..7bc865208b 100644 --- a/test-files/golden-tests/javadoc/brief-1.xml +++ b/test-files/golden-tests/javadoc/brief-1.xml @@ -8,7 +8,7 @@ brief bold - itcontinues to the line. + it continues to the line. diff --git a/test-files/golden-tests/javadoc/brief-2.adoc b/test-files/golden-tests/javadoc/brief-2.adoc index 214f42e3c4..5604ded150 100644 --- a/test-files/golden-tests/javadoc/brief-2.adoc +++ b/test-files/golden-tests/javadoc/brief-2.adoc @@ -14,33 +14,21 @@ | <> | brief - - | <> | brief - - | <> | brief - - | <> | brief x - - | <> | brief - - | <> | brief - - |=== [#f1] @@ -49,8 +37,6 @@ brief - - === Synopsis @@ -68,8 +54,6 @@ f1(); brief - - === Synopsis @@ -87,8 +71,6 @@ f2(); brief - - === Synopsis @@ -106,8 +88,6 @@ f3(); brief x - - === Synopsis @@ -132,8 +112,6 @@ brief brief - - === Synopsis @@ -151,8 +129,6 @@ f5(); brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/brief-2.html b/test-files/golden-tests/javadoc/brief-2.html index 78f681b48a..edf98caf83 100644 --- a/test-files/golden-tests/javadoc/brief-2.html +++ b/test-files/golden-tests/javadoc/brief-2.html @@ -18,22 +18,22 @@

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 @@ -43,7 +43,7 @@

Functions

f1

-

brief

+brief
@@ -64,7 +64,7 @@

Synopsis

f2

-

brief

+brief
@@ -85,7 +85,7 @@

Synopsis

f3

-

brief

+brief
@@ -106,7 +106,7 @@

Synopsis

f4

-

brief x

+brief x
@@ -133,7 +133,7 @@

Description

f5

-

brief

+brief
@@ -154,7 +154,7 @@

Synopsis

f6

-

brief

+brief
diff --git a/test-files/golden-tests/javadoc/brief-3.adoc b/test-files/golden-tests/javadoc/brief-3.adoc new file mode 100644 index 0000000000..b5ef0aa3e0 --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-3.adoc @@ -0,0 +1,156 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| C string overload. + +Integer overload. + + +|=== + +[#f] +== f + + +Integer overload. + +=== Synopsis + + +Declared in `<brief‐3.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +<>(int); +---- + +[.small]#<># + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +<>(char const*); +---- + +[.small]#<># + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +<>(double); +---- + +[.small]#<># + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +<>(float const*); +---- + +[.small]#<># + +=== Description + + +More info + + + +[#f-06] +== f + + +Integer overload. + +=== Synopsis + + +Declared in `<brief‐3.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f(int); +---- + +=== Description + + +More info + + + +[#f-07] +== f + + +C string overload. + +=== Synopsis + + +Declared in `<brief‐3.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f(char const*); +---- + +=== Description + + +More info + + + +[#f-0f] +== f + + +Integer overload. + +=== Synopsis + + +Declared in `<brief‐3.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f(double); +---- + +[#f-0b] +== f + + +C string overload. + +=== Synopsis + + +Declared in `<brief‐3.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f(float const*); +---- + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/javadoc/brief-3.cpp b/test-files/golden-tests/javadoc/brief-3.cpp new file mode 100644 index 0000000000..eee481bd0d --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-3.cpp @@ -0,0 +1,17 @@ +/** + * \brief Integer overload. + * \details More info + */ +void f(int); + +/** + * \brief C string overload. + * \details More info + */ +void f(const char*); + +/// Integer overload. +void f(double); + +/// C string overload. +void f(const float*); diff --git a/test-files/golden-tests/javadoc/brief-3.html b/test-files/golden-tests/javadoc/brief-3.html new file mode 100644 index 0000000000..1ef31e484d --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-3.html @@ -0,0 +1,183 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + +
NameDescription
f C string overload. + + +Integer overload. + + +
+
+
+
+

f

+
+Integer overload. + + +
+
+
+

Synopsis

+
+Declared in <brief-3.cpp>
+
+
+void
+f(int);
+
+
» more... + +
+
+void
+f(char const*);
+
+
» more... + +
+
+void
+f(double);
+
+
» more... + +
+
+void
+f(float const*);
+
+
» more... + + +
+
+

Description

+

More info

+ + +
+
+
+
+

f

+
+Integer overload. + + +
+
+
+

Synopsis

+
+Declared in <brief-3.cpp>
+
+
+void
+f(int);
+
+
+
+
+

Description

+

More info

+ + +
+
+
+
+

f

+
+C string overload. + + +
+
+
+

Synopsis

+
+Declared in <brief-3.cpp>
+
+
+void
+f(char const*);
+
+
+
+
+

Description

+

More info

+ + +
+
+
+
+

f

+
+Integer overload. + + +
+
+
+

Synopsis

+
+Declared in <brief-3.cpp>
+
+
+void
+f(double);
+
+
+
+
+
+
+

f

+
+C string overload. + + +
+
+
+

Synopsis

+
+Declared in <brief-3.cpp>
+
+
+void
+f(float const*);
+
+
+
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/golden-tests/javadoc/brief-3.xml b/test-files/golden-tests/javadoc/brief-3.xml new file mode 100644 index 0000000000..359a34a6ad --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-3.xml @@ -0,0 +1,60 @@ + + + + + + + + + + + Integer overload. + +
+ More info +
+ + + + + + + + + + + + C string overload. + +
+ More info +
+ + + + + + + + + + Integer overload. + + + + + + + + + + + + + C string overload. + + + + + diff --git a/test-files/golden-tests/javadoc/code.adoc b/test-files/golden-tests/javadoc/code.adoc index f87e9ec59f..b5cdcbd2d9 100644 --- a/test-files/golden-tests/javadoc/code.adoc +++ b/test-files/golden-tests/javadoc/code.adoc @@ -14,8 +14,6 @@ | <> | brief - - |=== [#f] @@ -24,8 +22,6 @@ brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/code.html b/test-files/golden-tests/javadoc/code.html index d083b5e781..6477bc029d 100644 --- a/test-files/golden-tests/javadoc/code.html +++ b/test-files/golden-tests/javadoc/code.html @@ -18,7 +18,7 @@

Functions

-f

brief

+f brief @@ -28,7 +28,7 @@

Functions

f

-

brief

+brief
diff --git a/test-files/golden-tests/javadoc/commands.adoc b/test-files/golden-tests/javadoc/commands.adoc index 79a7327680..4138325210 100644 --- a/test-files/golden-tests/javadoc/commands.adoc +++ b/test-files/golden-tests/javadoc/commands.adoc @@ -14,8 +14,6 @@ | <> | brief - - |=== [#f1] @@ -24,8 +22,6 @@ brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/commands.html b/test-files/golden-tests/javadoc/commands.html index 7ec8dc04b9..9def446c0a 100644 --- a/test-files/golden-tests/javadoc/commands.html +++ b/test-files/golden-tests/javadoc/commands.html @@ -18,7 +18,7 @@

Functions

-f1

brief

+f1 brief @@ -28,7 +28,7 @@

Functions

f1

-

brief

+brief
diff --git a/test-files/golden-tests/javadoc/duplicate-jdoc.adoc b/test-files/golden-tests/javadoc/duplicate-jdoc.adoc index 23d6da29e9..ff003c3cf6 100644 --- a/test-files/golden-tests/javadoc/duplicate-jdoc.adoc +++ b/test-files/golden-tests/javadoc/duplicate-jdoc.adoc @@ -14,33 +14,21 @@ | <> | f0 brief - - | <> | f1 brief - - | <> | g0 brief - - | <> | g1 brief - - | <> | h0 brief - - | <> | h1 brief - - |=== [#f0] @@ -49,8 +37,6 @@ f0 brief - - === Synopsis @@ -75,8 +61,6 @@ int f1 brief - - === Synopsis @@ -101,8 +85,6 @@ bool g0 brief - - === Synopsis @@ -136,8 +118,6 @@ g0(int a); g1 brief - - === Synopsis @@ -171,8 +151,6 @@ g1(int a); h0 brief - - === Synopsis @@ -207,8 +185,6 @@ h0(); h1 brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/duplicate-jdoc.html b/test-files/golden-tests/javadoc/duplicate-jdoc.html index 00cf3dc642..9c1427cc83 100644 --- a/test-files/golden-tests/javadoc/duplicate-jdoc.html +++ b/test-files/golden-tests/javadoc/duplicate-jdoc.html @@ -18,22 +18,22 @@

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 @@ -43,7 +43,7 @@

Functions

f0

-

f0 brief

+f0 brief
@@ -69,7 +69,7 @@

Return Value

f1

-

f1 brief

+f1 brief
@@ -95,7 +95,7 @@

Return Value

g0

-

g0 brief

+g0 brief
@@ -139,7 +139,7 @@

Parameters

g1

-

g1 brief

+g1 brief
@@ -183,7 +183,7 @@

Parameters

h0

-

h0 brief

+h0 brief
@@ -228,7 +228,7 @@

Template Parameters

h1

-

h1 brief

+h1 brief
diff --git a/test-files/golden-tests/javadoc/par-1.adoc b/test-files/golden-tests/javadoc/par-1.adoc index 0398d07157..773c5fe874 100644 --- a/test-files/golden-tests/javadoc/par-1.adoc +++ b/test-files/golden-tests/javadoc/par-1.adoc @@ -14,23 +14,15 @@ | <> | Brief - - | <> | Brief - - | <> | Brief - - | <> | Brief - - |=== [#f1] @@ -39,8 +31,6 @@ Brief - - === Synopsis @@ -72,8 +62,6 @@ void f1(); Brief - - === Synopsis @@ -105,8 +93,6 @@ void f2(); Brief - - === Synopsis @@ -136,8 +122,6 @@ void f3(); Brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/par-1.html b/test-files/golden-tests/javadoc/par-1.html index 846612718c..372330ecb7 100644 --- a/test-files/golden-tests/javadoc/par-1.html +++ b/test-files/golden-tests/javadoc/par-1.html @@ -18,16 +18,16 @@

Functions

-f1

Brief

+f1 Brief -f2

Brief

+f2 Brief -f3

Brief

+f3 Brief -f4

Brief

+f4 Brief @@ -37,7 +37,7 @@

Functions

f1

-

Brief

+Brief
@@ -68,7 +68,7 @@

Custom par

f2

-

Brief

+Brief
@@ -99,7 +99,7 @@

Custom par

f3

-

Brief

+Brief
@@ -129,7 +129,7 @@

Custom par

f4

-

Brief

+Brief
diff --git a/test-files/golden-tests/javadoc/para-1.adoc b/test-files/golden-tests/javadoc/para-1.adoc index 23e0e20449..3b73b53b0b 100644 --- a/test-files/golden-tests/javadoc/para-1.adoc +++ b/test-files/golden-tests/javadoc/para-1.adoc @@ -23,8 +23,6 @@ | <> | brief - - |=== [#f1] @@ -78,8 +76,6 @@ f3(); brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/para-1.html b/test-files/golden-tests/javadoc/para-1.html index fa68763068..a10ac4c8d4 100644 --- a/test-files/golden-tests/javadoc/para-1.html +++ b/test-files/golden-tests/javadoc/para-1.html @@ -24,7 +24,7 @@

Functions

f3 -f4

brief

+f4 brief @@ -82,7 +82,7 @@

Synopsis

f4

-

brief

+brief
diff --git a/test-files/golden-tests/javadoc/para-2.adoc b/test-files/golden-tests/javadoc/para-2.adoc index b026af6f15..185dd7cf39 100644 --- a/test-files/golden-tests/javadoc/para-2.adoc +++ b/test-files/golden-tests/javadoc/para-2.adoc @@ -14,8 +14,6 @@ | <> | brief - - |=== [#f1] @@ -24,8 +22,6 @@ brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/para-2.html b/test-files/golden-tests/javadoc/para-2.html index 4324b692d7..9d01441001 100644 --- a/test-files/golden-tests/javadoc/para-2.html +++ b/test-files/golden-tests/javadoc/para-2.html @@ -18,7 +18,7 @@

Functions

-f1

brief

+f1 brief @@ -28,7 +28,7 @@

Functions

f1

-

brief

+brief
diff --git a/test-files/golden-tests/javadoc/para-3.html b/test-files/golden-tests/javadoc/para-3.html index 38172763fd..7de458d6a4 100644 --- a/test-files/golden-tests/javadoc/para-3.html +++ b/test-files/golden-tests/javadoc/para-3.html @@ -19,6 +19,7 @@

Functions

my_function A function + @@ -29,6 +30,7 @@

my_function

A function +
diff --git a/test-files/golden-tests/javadoc/ref.adoc b/test-files/golden-tests/javadoc/ref.adoc index 02bc9b255d..e502316c1e 100644 --- a/test-files/golden-tests/javadoc/ref.adoc +++ b/test-files/golden-tests/javadoc/ref.adoc @@ -33,13 +33,9 @@ | <> | See xref:#A-f1[A::f1] - - | <> | See xref:#F-operator_bitnot[F::operator~] - - |=== [#A] @@ -55,8 +51,6 @@ | <> | See xref:#A-f1[f1] - - | <> | @@ -73,8 +67,6 @@ | <> | See xref:#f0[f0] - - |=== [#A-B] @@ -83,8 +75,6 @@ See xref:#A-f1[f1] - - === Synopsis @@ -211,8 +201,6 @@ struct D | <> | See xref:#A-C-f3[f3] - - |=== === Member Functions @@ -232,8 +220,6 @@ struct D See xref:#A-C-f3[f3] - - === Synopsis @@ -277,8 +263,6 @@ f4(); See xref:#f0[f0] - - === Synopsis @@ -966,8 +950,6 @@ f0(); See xref:#A-f1[A::f1] - - === Synopsis @@ -992,8 +974,6 @@ See xref:#A-f1[::A::f1] See xref:#F-operator_bitnot[F::operator~] - - === Synopsis diff --git a/test-files/golden-tests/javadoc/ref.html b/test-files/golden-tests/javadoc/ref.html index fc43d744d6..5aceffe2c9 100644 --- a/test-files/golden-tests/javadoc/ref.html +++ b/test-files/golden-tests/javadoc/ref.html @@ -44,10 +44,10 @@

Functions

f0 -f5

See A::f1

+f5 See A::f1 -f6

See F::operator~

+f6 See F::operator~ @@ -66,7 +66,7 @@

Types

-B

See f1

+B See f1 C @@ -84,7 +84,7 @@

Functions

-f1

See f0

+f1 See f0 @@ -94,7 +94,7 @@

Functions

A::B

-

See f1

+See f1
@@ -234,7 +234,7 @@

Types

-E

See f3

+E See f3 @@ -259,7 +259,7 @@

Member Functions

A::D::E

-

See f3

+See f3
@@ -304,7 +304,7 @@

Synopsis

A::f1

-

See f0

+See f0
@@ -1038,7 +1038,7 @@

Synopsis

f5

-

See A::f1

+See A::f1
@@ -1065,7 +1065,7 @@

Description

f6

diff --git a/test-files/golden-tests/javadoc/styled.adoc b/test-files/golden-tests/javadoc/styled.adoc index 32fca814c5..8a9d6ab85f 100644 --- a/test-files/golden-tests/javadoc/styled.adoc +++ b/test-files/golden-tests/javadoc/styled.adoc @@ -14,8 +14,6 @@ | <> | Brief for A - - |=== [#A] @@ -24,8 +22,6 @@ Brief for A - - === Synopsis @@ -45,8 +41,6 @@ struct A; | <> | Compare function - - |=== @@ -66,8 +60,6 @@ We can also escape these markers: `, *, and _. Compare function - - === Synopsis diff --git a/test-files/golden-tests/javadoc/styled.html b/test-files/golden-tests/javadoc/styled.html index 97ce9b64dc..f7493aea40 100644 --- a/test-files/golden-tests/javadoc/styled.html +++ b/test-files/golden-tests/javadoc/styled.html @@ -18,7 +18,7 @@

Types

-A

Brief for A

+A Brief for A @@ -28,7 +28,7 @@

Types

A

-

Brief for A

+Brief for A
@@ -52,7 +52,7 @@

Member Functions

-compare

Compare function

+compare Compare function @@ -71,7 +71,7 @@

Description

A::compare

-

Compare function

+Compare function
diff --git a/test-files/golden-tests/javadoc/throw.adoc b/test-files/golden-tests/javadoc/throw.adoc index a71954e62e..4a373602e0 100644 --- a/test-files/golden-tests/javadoc/throw.adoc +++ b/test-files/golden-tests/javadoc/throw.adoc @@ -14,8 +14,6 @@ | <> | brief - - |=== [#f] @@ -24,8 +22,6 @@ brief - - === Synopsis diff --git a/test-files/golden-tests/javadoc/throw.html b/test-files/golden-tests/javadoc/throw.html index 18f51940fc..3947f24f43 100644 --- a/test-files/golden-tests/javadoc/throw.html +++ b/test-files/golden-tests/javadoc/throw.html @@ -18,7 +18,7 @@

Functions

-f

brief

+f brief @@ -28,7 +28,7 @@

Functions

f

-

brief

+brief
diff --git a/test-files/golden-tests/metadata/enum.adoc b/test-files/golden-tests/metadata/enum.adoc index 00a0ce1ded..220f865366 100644 --- a/test-files/golden-tests/metadata/enum.adoc +++ b/test-files/golden-tests/metadata/enum.adoc @@ -14,16 +14,12 @@ | <> | E0 brief. - - | <> | | <> | E2 brief. - - | <> | @@ -35,8 +31,6 @@ E0 brief. - - === Synopsis @@ -55,12 +49,8 @@ enum E0; |Name |Description |`e0` |e0 brief. - - |`e1` |e1 brief. - - |=== === Description @@ -102,8 +92,6 @@ enum E1 : char; E2 brief. - - === Synopsis @@ -122,12 +110,8 @@ enum class E2 : int; |Name |Description |`e4` |e4 brief. - - |`e5` |e5 brief. - - |=== === Description diff --git a/test-files/golden-tests/metadata/enum.html b/test-files/golden-tests/metadata/enum.html index 664c4bc92c..6e96297bb8 100644 --- a/test-files/golden-tests/metadata/enum.html +++ b/test-files/golden-tests/metadata/enum.html @@ -18,12 +18,12 @@

Enums

-E0

E0 brief.

+E0 E0 brief. E1 -E2

E2 brief.

+E2 E2 brief. E3 @@ -35,7 +35,7 @@

Enums

E0

-

E0 brief.

+E0 brief.
@@ -62,12 +62,12 @@

Members

e0 -

e0 brief.

+e0 brief. e1 -

e1 brief.

+e1 brief. @@ -120,7 +120,7 @@

Members

E2

-

E2 brief.

+E2 brief.
@@ -147,12 +147,12 @@

Members

e4 -

e4 brief.

+e4 brief. e5 -

e5 brief.

+e5 brief. diff --git a/test-files/golden-tests/metadata/friend-1.adoc b/test-files/golden-tests/metadata/friend-1.adoc index eb9f969356..376e8b9475 100644 --- a/test-files/golden-tests/metadata/friend-1.adoc +++ b/test-files/golden-tests/metadata/friend-1.adoc @@ -22,8 +22,6 @@ | <> | f - - |=== [#T] @@ -49,8 +47,6 @@ struct T; | <> | f - - |=== @@ -61,8 +57,6 @@ struct T; f - - === Synopsis @@ -81,8 +75,6 @@ f(); f - - === Synopsis diff --git a/test-files/golden-tests/metadata/friend-1.html b/test-files/golden-tests/metadata/friend-1.html index fe295febde..c95818b087 100644 --- a/test-files/golden-tests/metadata/friend-1.html +++ b/test-files/golden-tests/metadata/friend-1.html @@ -30,7 +30,7 @@

Functions

-f

f

+f f @@ -59,7 +59,7 @@

Friends

-f

f

+f f @@ -71,7 +71,7 @@

Friends

f

-

f

+f
@@ -93,7 +93,7 @@

Synopsis

f

-

f

+f
diff --git a/test-files/golden-tests/metadata/friend-2.adoc b/test-files/golden-tests/metadata/friend-2.adoc index 5db260bf1b..c088532618 100644 --- a/test-files/golden-tests/metadata/friend-2.adoc +++ b/test-files/golden-tests/metadata/friend-2.adoc @@ -22,8 +22,6 @@ | <> | f - - |=== [#T] @@ -49,8 +47,6 @@ struct T; | <> | f - - |=== @@ -61,8 +57,6 @@ struct T; f - - === Synopsis @@ -81,8 +75,6 @@ f(); f - - === Synopsis diff --git a/test-files/golden-tests/metadata/friend-2.html b/test-files/golden-tests/metadata/friend-2.html index 6960891a38..23e3e6b078 100644 --- a/test-files/golden-tests/metadata/friend-2.html +++ b/test-files/golden-tests/metadata/friend-2.html @@ -30,7 +30,7 @@

Functions

-f

f

+f f @@ -59,7 +59,7 @@

Friends

-f

f

+f f @@ -71,7 +71,7 @@

Friends

f

-

f

+f
@@ -93,7 +93,7 @@

Synopsis

f

-

f

+f
diff --git a/test-files/golden-tests/metadata/friend-3.adoc b/test-files/golden-tests/metadata/friend-3.adoc index ee134fe60d..013a062d4a 100644 --- a/test-files/golden-tests/metadata/friend-3.adoc +++ b/test-files/golden-tests/metadata/friend-3.adoc @@ -23,8 +23,6 @@ | <> | T::f - - |=== [#T] @@ -50,8 +48,6 @@ struct T; | <> | T::f - - |=== @@ -62,8 +58,6 @@ struct T; T::f - - === Synopsis @@ -123,8 +117,6 @@ f(); T::f - - === Synopsis diff --git a/test-files/golden-tests/metadata/friend-3.html b/test-files/golden-tests/metadata/friend-3.html index af920d7ea4..17b531d081 100644 --- a/test-files/golden-tests/metadata/friend-3.html +++ b/test-files/golden-tests/metadata/friend-3.html @@ -31,7 +31,7 @@

Functions

-f

T::f

+f T::f @@ -60,7 +60,7 @@

Friends

-f

T::f

+f T::f @@ -72,7 +72,7 @@

Friends

f

-

T::f

+T::f
@@ -140,7 +140,7 @@

Synopsis

f

-

T::f

+T::f
diff --git a/test-files/golden-tests/metadata/friend-4.adoc b/test-files/golden-tests/metadata/friend-4.adoc index ae56a5fa83..d85ff73253 100644 --- a/test-files/golden-tests/metadata/friend-4.adoc +++ b/test-files/golden-tests/metadata/friend-4.adoc @@ -23,8 +23,6 @@ | <> | U::f - - |=== [#T] @@ -91,8 +89,6 @@ struct U; | <> | U::f - - |=== @@ -103,8 +99,6 @@ struct U; U::f - - === Synopsis @@ -123,8 +117,6 @@ f(); U::f - - === Synopsis diff --git a/test-files/golden-tests/metadata/friend-4.html b/test-files/golden-tests/metadata/friend-4.html index 8699e78050..3c2f78992b 100644 --- a/test-files/golden-tests/metadata/friend-4.html +++ b/test-files/golden-tests/metadata/friend-4.html @@ -31,7 +31,7 @@

Functions

-f

U::f

+f U::f @@ -106,7 +106,7 @@

Friends

-f

U::f

+f U::f @@ -118,7 +118,7 @@

Friends

f

-

U::f

+U::f
@@ -140,7 +140,7 @@

Synopsis

f

-

U::f

+U::f
diff --git a/test-files/golden-tests/metadata/friend-5.adoc b/test-files/golden-tests/metadata/friend-5.adoc index bc46db028f..b7ccf9db44 100644 --- a/test-files/golden-tests/metadata/friend-5.adoc +++ b/test-files/golden-tests/metadata/friend-5.adoc @@ -23,8 +23,6 @@ | <> | f - - |=== [#T] @@ -115,8 +113,6 @@ f(); f - - === Synopsis diff --git a/test-files/golden-tests/metadata/friend-5.html b/test-files/golden-tests/metadata/friend-5.html index 3ca0d29d1e..cf15d440ea 100644 --- a/test-files/golden-tests/metadata/friend-5.html +++ b/test-files/golden-tests/metadata/friend-5.html @@ -31,7 +31,7 @@

Functions

-f

f

+f f @@ -133,7 +133,7 @@

Synopsis

f

-

f

+f
diff --git a/test-files/golden-tests/metadata/friend-6.adoc b/test-files/golden-tests/metadata/friend-6.adoc index 3790b21fef..b21dc8686e 100644 --- a/test-files/golden-tests/metadata/friend-6.adoc +++ b/test-files/golden-tests/metadata/friend-6.adoc @@ -14,18 +14,12 @@ | <> | Struct T brief - - | <> | Struct U brief - - | <> | Struct V brief - - | <> | @@ -37,8 +31,6 @@ Struct T brief - - === Synopsis @@ -58,13 +50,9 @@ struct T; | <> | Friend class Z brief - - | <> | Friend int brief - - |=== @@ -75,8 +63,6 @@ struct T; Friend class Z brief - - === Synopsis @@ -93,8 +79,6 @@ friend <>; Friend int brief - - === Synopsis @@ -111,8 +95,6 @@ friend int; Struct U brief - - === Synopsis @@ -132,8 +114,6 @@ struct U; | <> | Friend T brief - - |=== @@ -144,8 +124,6 @@ struct U; Friend T brief - - === Synopsis @@ -162,8 +140,6 @@ friend <>; Struct V brief - - === Synopsis @@ -183,8 +159,6 @@ struct V; | <> | Friend struct U brief - - |=== @@ -195,8 +169,6 @@ struct V; Friend struct U brief - - === Synopsis diff --git a/test-files/golden-tests/metadata/friend-6.html b/test-files/golden-tests/metadata/friend-6.html index 589f973dc8..d758de94cf 100644 --- a/test-files/golden-tests/metadata/friend-6.html +++ b/test-files/golden-tests/metadata/friend-6.html @@ -18,13 +18,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 @@ -36,7 +36,7 @@

Types

T

-

Struct T brief

+Struct T brief
@@ -60,10 +60,10 @@

Friends

-class Z

Friend class Z brief

+class Z Friend class Z brief -int

Friend int brief

+int Friend int brief @@ -75,7 +75,7 @@

Friends

Z

-

Friend class Z brief

+Friend class Z brief
@@ -95,7 +95,7 @@

Synopsis

int

-

Friend int brief

+Friend int brief
@@ -115,7 +115,7 @@

Synopsis

U

-

Struct U brief

+Struct U brief
@@ -139,7 +139,7 @@

Friends

-T

Friend T brief

+T Friend T brief @@ -151,7 +151,7 @@

Friends

T

-

Friend T brief

+Friend T brief
@@ -171,7 +171,7 @@

Synopsis

V

-

Struct V brief

+Struct V brief
@@ -195,7 +195,7 @@

Friends

-struct U

Friend struct U brief

+struct U Friend struct U brief @@ -207,7 +207,7 @@

Friends

U

-

Friend struct U brief

+Friend struct U brief
diff --git a/test-files/golden-tests/metadata/record-1.adoc b/test-files/golden-tests/metadata/record-1.adoc index d675d5319f..a26cf46b70 100644 --- a/test-files/golden-tests/metadata/record-1.adoc +++ b/test-files/golden-tests/metadata/record-1.adoc @@ -57,18 +57,12 @@ struct T; | <> | brief‐g1 - - | <> | brief‐g2 - - | <> | brief‐g3 - - |=== @@ -123,8 +117,6 @@ f3(); brief‐g1 - - === Synopsis @@ -149,8 +141,6 @@ desc brief‐g2 - - === Synopsis @@ -175,8 +165,6 @@ the number 2 brief‐g3 - - === Synopsis diff --git a/test-files/golden-tests/metadata/record-1.html b/test-files/golden-tests/metadata/record-1.html index e595dbcfca..e641bfab26 100644 --- a/test-files/golden-tests/metadata/record-1.html +++ b/test-files/golden-tests/metadata/record-1.html @@ -73,13 +73,13 @@

Protected Member Functions

-g1

brief-g1

+g1 brief-g1 -g2

brief-g2

+g2 brief-g2 -g3

brief-g3

+g3 brief-g3 @@ -138,7 +138,7 @@

Synopsis

T::g1

-

brief-g1

+brief-g1
@@ -165,7 +165,7 @@

Description

T::g2

-

brief-g2

+brief-g2
@@ -191,7 +191,7 @@

Return Value

T::g3

-

brief-g3

+brief-g3
diff --git a/test-files/golden-tests/metadata/sfinae.adoc b/test-files/golden-tests/metadata/sfinae.adoc index 6514206618..a1bd59a962 100644 --- a/test-files/golden-tests/metadata/sfinae.adoc +++ b/test-files/golden-tests/metadata/sfinae.adoc @@ -22,13 +22,9 @@ | <> | The partial specialization of A is enabled via a template parameter - - | <> | Specialization for floating point types - - |=== === Functions @@ -39,53 +35,33 @@ | <> | Enabled via return type - - | <> | Enabled via type template parameter - - | <> | Enabling a specified return type - - | <> | Enabling a specified return type in another namespace - - | <> | Enabled via return type with std::enable_if - - | <> | Enabled via a non‐type template parameter with helper - - | <> | Enabled via a non‐type template parameter without helper - - | <> | Enabled via a non‐type template parameter using int instead of bool - - | <> | Enabled via parameter without helper - - | <> | Enabled via parameter with helper - - |=== [#B] @@ -124,8 +100,6 @@ struct C; The partial specialization of A is enabled via a template parameter - - === Synopsis @@ -148,8 +122,6 @@ class A; Specialization for floating point types - - === Synopsis @@ -170,8 +142,6 @@ class <><T, void>; Enabled via return type - - === Synopsis @@ -190,8 +160,6 @@ f1(T value); Enabled via type template parameter - - === Synopsis @@ -223,8 +191,6 @@ This does not work because the declarations are treated as redeclarations of the Enabling a specified return type - - === Synopsis @@ -243,8 +209,6 @@ f2(T value); Enabling a specified return type in another namespace - - === Synopsis @@ -263,8 +227,6 @@ f3(T value); Enabled via return type with std::enable_if - - === Synopsis @@ -283,8 +245,6 @@ f4(T value); Enabled via a non‐type template parameter with helper - - === Synopsis @@ -305,8 +265,6 @@ f5(T value); Enabled via a non‐type template parameter without helper - - === Synopsis @@ -327,8 +285,6 @@ f6(T value); Enabled via a non‐type template parameter using int instead of bool - - === Synopsis @@ -349,8 +305,6 @@ f7(T value); Enabled via parameter without helper - - === Synopsis @@ -371,8 +325,6 @@ f8( Enabled via parameter with helper - - === Synopsis diff --git a/test-files/golden-tests/metadata/sfinae.html b/test-files/golden-tests/metadata/sfinae.html index 1d9c9d4e52..0291e52299 100644 --- a/test-files/golden-tests/metadata/sfinae.html +++ b/test-files/golden-tests/metadata/sfinae.html @@ -30,10 +30,10 @@

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, void>

Specialization for floating point types

+A<T, void> Specialization for floating point types @@ -47,34 +47,34 @@

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 @@ -118,7 +118,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
@@ -143,7 +143,7 @@

Synopsis

A<T, void>

-

Specialization for floating point types

+Specialization for floating point types
@@ -166,7 +166,7 @@

Synopsis

f1

-

Enabled via return type

+Enabled via return type
@@ -188,7 +188,7 @@

Synopsis

f10

-

Enabled via type template parameter

+Enabled via type template parameter
@@ -220,7 +220,7 @@

Description

f2

-

Enabling a specified return type

+Enabling a specified return type
@@ -242,7 +242,7 @@

Synopsis

f3

-

Enabling a specified return type in another namespace

+Enabling a specified return type in another namespace
@@ -264,7 +264,7 @@

Synopsis

f4

-

Enabled via return type with std::enable_if

+Enabled via return type with std::enable_if
@@ -286,7 +286,7 @@

Synopsis

f5

-

Enabled via a non-type template parameter with helper

+Enabled via a non-type template parameter with helper
@@ -310,7 +310,7 @@

Synopsis

f6

-

Enabled via a non-type template parameter without helper

+Enabled via a non-type template parameter without helper
@@ -334,7 +334,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
@@ -358,7 +358,7 @@

Synopsis

f8

-

Enabled via parameter without helper

+Enabled via parameter without helper
@@ -382,7 +382,7 @@

Synopsis

f9

-

Enabled via parameter with helper

+Enabled via parameter with helper
diff --git a/test-files/golden-tests/snippets/distance.adoc b/test-files/golden-tests/snippets/distance.adoc index 8278ee917c..6954242a6e 100644 --- a/test-files/golden-tests/snippets/distance.adoc +++ b/test-files/golden-tests/snippets/distance.adoc @@ -14,8 +14,6 @@ | <> | Return the distance between two points - - |=== [#distance] @@ -24,8 +22,6 @@ Return the distance between two points - - === Synopsis diff --git a/test-files/golden-tests/snippets/distance.html b/test-files/golden-tests/snippets/distance.html index 6519478515..a77fe0d137 100644 --- a/test-files/golden-tests/snippets/distance.html +++ b/test-files/golden-tests/snippets/distance.html @@ -18,7 +18,7 @@

Functions

-distance

Return the distance between two points

+distance Return the distance between two points @@ -28,7 +28,7 @@

Functions

distance

-

Return the distance between two points

+Return the distance between two points
diff --git a/test-files/golden-tests/snippets/is_prime.adoc b/test-files/golden-tests/snippets/is_prime.adoc index d1b871ada3..f433931aef 100644 --- a/test-files/golden-tests/snippets/is_prime.adoc +++ b/test-files/golden-tests/snippets/is_prime.adoc @@ -14,8 +14,6 @@ | <> | Return true if a number is prime. - - |=== [#is_prime] @@ -24,8 +22,6 @@ Return true if a number is prime. - - === Synopsis diff --git a/test-files/golden-tests/snippets/is_prime.html b/test-files/golden-tests/snippets/is_prime.html index 91257d7381..ae40541aa9 100644 --- a/test-files/golden-tests/snippets/is_prime.html +++ b/test-files/golden-tests/snippets/is_prime.html @@ -18,7 +18,7 @@

Functions

-is_prime

Return true if a number is prime.

+is_prime Return true if a number is prime. @@ -28,7 +28,7 @@

Functions

is_prime

-

Return true if a number is prime.

+Return true if a number is prime.
diff --git a/test-files/golden-tests/snippets/sqrt.adoc b/test-files/golden-tests/snippets/sqrt.adoc index f357e6a0df..5f4548efa8 100644 --- a/test-files/golden-tests/snippets/sqrt.adoc +++ b/test-files/golden-tests/snippets/sqrt.adoc @@ -14,8 +14,6 @@ | <> | Computes the square root of an integral value. - - |=== [#sqrt] @@ -24,8 +22,6 @@ Computes the square root of an integral value. - - === Synopsis diff --git a/test-files/golden-tests/snippets/sqrt.html b/test-files/golden-tests/snippets/sqrt.html index e723b10a4d..1aec9d79b2 100644 --- a/test-files/golden-tests/snippets/sqrt.html +++ b/test-files/golden-tests/snippets/sqrt.html @@ -18,7 +18,7 @@

Functions

-sqrt

Computes the square root of an integral value.

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

Functions

sqrt

-

Computes the square root of an integral value.

+Computes the square root of an integral value.
diff --git a/test-files/golden-tests/snippets/terminate.adoc b/test-files/golden-tests/snippets/terminate.adoc index 5c70c8d359..ef0db3ac2a 100644 --- a/test-files/golden-tests/snippets/terminate.adoc +++ b/test-files/golden-tests/snippets/terminate.adoc @@ -14,8 +14,6 @@ | <> | Exit the program. - - |=== [#terminate] @@ -24,8 +22,6 @@ Exit the program. - - === Synopsis diff --git a/test-files/golden-tests/snippets/terminate.html b/test-files/golden-tests/snippets/terminate.html index 6ece5e2f05..c85b32e33b 100644 --- a/test-files/golden-tests/snippets/terminate.html +++ b/test-files/golden-tests/snippets/terminate.html @@ -18,7 +18,7 @@

Functions

-terminate

Exit the program.

+terminate Exit the program. @@ -28,7 +28,7 @@

Functions

terminate

-

Exit the program.

+Exit the program.