[Doxygen-users] Doxygen and Python DocString

[Felix K. <Fel...@ki...>]

Hello all,
I want to double check that I am not missing something.

I am trying to use doxygen for a Python project, I submitted this issue(https://github.com/doxygen/doxygen/issues/7953) and it got solved quickly, which was amazing.
Now I am trying to generate documentation for my python project that uses docstring and I think I found a missing feature.

At least some projects (including some I am working with) document function/method parameters using
:param {ParamenterName}: Description of the parameter
to document parameters. Doxygen seems to only accept @param, which is more JavaDoc then Python Docstring.

Below is a more precise example.

def example_working(parameter, parameter_with_default=False):
    """
    Use this method to show how python and doxygen work together
    @param parameter This parameter is amazing
    @param parameter_with_default This parameter is even better
    """
    pass

def example_not_working(parameter, parameter_with_default=False):
    """
    Use this method to show how python and doxygen work together
    :param parameter: This parameter is amazing
    :param parameter_with_default: This parameter is even better
    """
    pass

Is there a way for doxygen to understand the :param: marker?
Should I submit this as an issue or is it out of scope for doxygen?

Many thanks,
Felix