Feneric / doxypypy

A more Pythonic version of doxypy, a Doxygen filter for Python.
GNU General Public License v2.0
149 stars 49 forks source link

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

Open wohauser opened 6 years ago

wohauser commented 6 years ago

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.