Skip to content
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.

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

Using /// breaks markdown headings #41

Closed
grantroch opened this issue Mar 20, 2024 · 4 comments
Closed

Using /// breaks markdown headings #41

grantroch opened this issue Mar 20, 2024 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@grantroch
Copy link

Using markdown headers within a doc-comment does not render the header correctly. This is very similar to #38 in that using /** ... */ works but /// does not but for the header instead. Below the same example code as in that case.

namespace example {

/** First function
 *
 * This one uses block comments and multiple paragraphs and such can be used.
 *
 * #### Example
 *
 * ```c++
 * first();
 * ```
 */
void first();

/// Second function
///
/// This one uses single-line comments and the paragraphs are broken.
///
/// #### Example
///
/// ```c++
/// second();
/// ```
void second();

} // namespace example

This renders the header correctly for first but not for second. From what I can see, the only difference in the rendered markdown is an extra space before the markdown in the instance that doesn't work.
image

@lawmurray
Copy link
Owner

Thanks for the report @grantroch. I've reproduced this and am looking into it.

@lawmurray lawmurray self-assigned this Apr 5, 2024
@lawmurray lawmurray added the bug Something isn't working label Apr 5, 2024
@lawmurray
Copy link
Owner

A little more testing to come, but generally have this fixed now along with other related issues (e.g. admonitions had similar problems).

@lawmurray
Copy link
Owner

Thanks again for this report @grantroch . Fixes our now incorporated into v0.4.5 and released.

@grantroch
Copy link
Author

Thank you, @lawmurray!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants