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

Add doxygen command note and fix warning #35

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dagnic
Copy link

@dagnic dagnic commented Nov 27, 2023

This PR adds the doxygen @note command and fix the @warning one.

Test docstring:

/**
 * This is a method to test docstring parsing with pybind11-mkdoc
 * @note Test pybind11-mkdoc
 * @warning This method has no implementation
 * @param a     roll angle
 * @param b     value b
 */
void myMethod(int a, int b);

Without the patch:

static const char *__doc_myMethod =
R"doc(This is a method to test docstring parsing with pybind11-mkdoc @note
Test pybind11-mkdoc $.. warning::

This method has no implementation

Parameter ``a``:
    roll angle

Parameter ``b``:
    value b)doc";

With the patch:

static const char *__doc_myMethod =
R"doc(This is a method to test docstring parsing with pybind11-mkdoc

.. note::
    Test pybind11-mkdoc

.. warning::
    This method has no implementation

Parameter ``a``:
    roll angle

Parameter ``b``:
    value b)doc";

Maybe, other commands such as @deprecated, @todo, @code or @since should be fixed also.

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

Successfully merging this pull request may close these issues.

1 participant