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

Parameters start with error are processed as code block. #50

Open
wohauser opened this issue Jan 10, 2018 · 0 comments
Open

Parameters start with error are processed as code block. #50

wohauser opened this issue Jan 10, 2018 · 0 comments

Comments

@wohauser
Copy link

We have following docstring:

"""
Wrapper for @ref wait_until_state_reached, for cases when the intended call is for that marker to be reached

    Args:
        marker_extensions (dict): Extra content for the marker

        marker_name (str) : Identifier of the marker.

        name (str):  Key of marker content. If empty string, then the content will be an empty dict

        timeout (int):  the max amount of seconds to wait for this marker to be reached.
        
        error_contents (list of dict) : List of markers treated as error condition, causing the
                       method to return false if one was found.
                       Content of dict {"\<MarkerType\>": {\<Marker Content\>}}
    """

the processing results in:

## @brief         Wrapper for @ref wait_until_state_reached, for cases when the intended call is for that marker to be reached
#
#
# @param            marker_extensions       Extra content for the marker
#
# @param            marker_name     Identifier of the marker.
#
# @param            name    Key of marker content. If empty string, then the content will be an empty dict
#
# @param            timeout the max amount of seconds to wait for this marker to be reached.
#            error_contents (list of dict) : List of markers treated as error condition, causing the
#                           method to return false if one was found.
#                           Content of dict {"\<MarkerType\>": {\<Marker Content\>}}
#

witch forces doxygen to put "error_contents ....." into a code block.
we expect a @param here.

Maybe the regex "__errorLineRE" have to be fine tuned.

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