Skip to content

fix: rendering of Markdown inline formatting and bullet lists (#1156) #1157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gennaroprota merged 5 commits into from
Mar 9, 2026
Merged

fix: rendering of Markdown inline formatting and bullet lists (#1156) #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d80912
fix: rendering of Markdown inline formatting and bullet lists (#1156)
gennaroprota Feb 5, 2026
23bf426
fix: missing @return command in doc comment
gennaroprota Feb 6, 2026
99a1cb9
fix: bottomUpTraverse() skips ListBlock items
gennaroprota Feb 9, 2026
be1c2b7
test: cover additional paths in DocCommentFinalizer.cpp
gennaroprota Feb 10, 2026
fa3ff19
fix: HTML code blocks not wrapped in <pre>...</pre>
gennaroprota Feb 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions include/mrdocs/ADT/Optional.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -962,6 +962,8 @@ class Optional<T&> {
constexpr
bool
/** Return true because Optional<T&> never allocates storage.

@return `true` always.
Comment thread
gennaroprota marked this conversation as resolved.
*/
is_inlined() noexcept
{
Expand Down
19 changes: 19 additions & 0 deletions include/mrdocs/Metadata/DocComment.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,16 @@ requires std::same_as<T, doc::Block> || std::same_as<T, doc::Inline>
void
traverseImpl(T& baseNode, F&& func);

template <bool bottomUp, class F>
void
traverseImpl(doc::ListItem& item, F&& func)
{
for (auto& block : item.blocks)
{
traverseImpl<bottomUp>(block, func);
}
}

// Traverse a derived node
template <bool bottomUp, DocCommentNode NodeTy, class F>
requires(!std::same_as<NodeTy, doc::Block> && !std::same_as<NodeTy, doc::Inline>)
Expand Down Expand Up @@ -255,6 +265,15 @@ traverseImpl(NodeTy& N, F&& func)
{
traverseImpl<bottomUp>(N.exception, func);
}

if constexpr (std::same_as<NodeTy, doc::ListBlock>)
{
for (auto& item: N.items)
{
traverseImpl<bottomUp>(item, func);
}
}

if constexpr (bottomUp && std::invocable<F, NodeTy&>)
{
func(N);
Expand Down
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/adoc/partials/doc/block/list.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{{#each items}}
* {{#each blocks}}{{#unless @first}}
{{{repeat "*" (or ../depth 1)}}} {{#each blocks}}{{#unless @first}}

+
{{/unless}}
{{#if (eq kind "paragraph")}}{{> doc/inline-container }}{{else}}{{> doc/block }}{{/if}}
{{#if (eq kind "paragraph")}}{{> doc/inline-container }}{{else if (eq kind "list")}}{{> doc/block/list depth=(add (or ../../depth 1) 1) }}{{else}}{{> doc/block }}{{/if}}
{{/each}}
{{/each}}

4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/html/partials/doc/block/code.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<code class="language-{{ or info "cpp" }}">
<pre><code class="language-{{ or info "cpp" }}">
{{{ replace (replace (replace literal "&" "&amp;") ">" "&gt;") "<" "&lt;" }}}
</code>
</code></pre>
7 changes: 7 additions & 0 deletions share/mrdocs/addons/generator/html/partials/doc/inline.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{{~#if (eq kind "text")~}}{{> doc/inline/text}}{{~/if~}}
{{~#if (eq kind "strong")~}}{{> doc/inline/strong}}{{~/if~}}
{{~#if (eq kind "emph")~}}{{> doc/inline/emph}}{{~/if~}}
{{~#if (eq kind "code")~}}{{> doc/inline/code}}{{~/if~}}
{{~#if (eq kind "link")~}}{{> doc/inline/link}}{{~/if~}}
{{~#if (eq kind "reference")~}}{{> doc/inline/reference}}{{~/if~}}
{{~#if (eq kind "copy-details")~}}{{> doc/inline/copy-details}}{{~/if~}}
1 change: 1 addition & 0 deletions share/mrdocs/addons/generator/html/partials/markup/b.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<strong>{{> @partial-block }}</strong>
Loading
Loading