Skip to content

Markdown Lists are broken in Doxygen #52

Description

@whatchamacallem

Thank you for your useful tool.

The following Doxygen style for C++ does not get formatted correctly:

/// Releases the value referenced by `handle` if `deleter` is true then
/// calls `deleter` on it.
/// - `handle` : The handle identifying the value to remove.
/// - `deleter` : Callable with signature `bool deleter(T*)`.
template<typename deleter_u_>
bool erase(hxhandle_t handle_, const deleter_u_& deleter_) noexcept;

It ends up looking like this:

/// Releases the value referenced by `handle` if `deleter` is true then
/// calls `deleter` on it. - `handle` : The handle identifying the value to
/// remove. - `deleter` : Callable with signature `bool deleter(T*)`.
template<typename deleter_u_>
bool erase(hxhandle_t handle_, const deleter_u_& deleter_) noexcept;

Which makes it hard to reformat the docs for a number of functions all at once.

Doxygen Native Commands are old and tired. Markdown is shiny and new. Please enable Markdown formatting in Doxygen comments. There could always be an option to turn it off.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions