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

En-dash in @return renders incorrectly #963

Open
mcejp opened this issue Dec 7, 2023 · 0 comments
Open

En-dash in @return renders incorrectly #963

mcejp opened this issue Dec 7, 2023 · 0 comments

Comments

@mcejp
Copy link

mcejp commented Dec 7, 2023

First of all, thank you so much for your work on this project. It really is a game changer for C++ docs.

Now, I'm struggling a bit to explain this problem concisely, but I think an example will make it very clear.

C++/Doxygen code:

    /**
     * Check if there is a message in the queue, and return its length.
     * This can be used to appropriately size the buffer for a subsequent call to read().
     *
     * @return The length of a pending message. This excludes the header -- a return value of 0 indicates a message
     *         with a header and an empty body. @b std::nullopt is returned if there is no message to read.
     */
    std::optional<size_t> getPendingMessageSize();

(this is inside a class, in case it makes any difference)

RST code:

.. doxygenclass:: bmboot::MessageQueueReader
   :members:

HTML output:

image

FWIW, the relevant part of the Doxygen XML looks like this:

This excludes the header <ndash/> a return value of 0 indicates a message with a header and an empty body.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant