Feneric / doxypypy

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

How to specify the type of an argument? #89

Open buhtz opened 2 years ago

buhtz commented 2 years ago

Hello,

referencing your example code in the README.md I ask myself if there is a way to specify the type of an argument. E.g. something like this

def myfunction(arg1, arg2, kwarg='whatever.'):
    """
    Does nothing more than demonstrate syntax.

    This is an example of how a Pythonic human-readable docstring can
    get parsed by doxypypy and marked up with Doxygen commands as a
    regular input filter to Doxygen.

    Args:
        arg1(int):   A positional argument.
        arg2(string):   Another positional argument.

But it does not work. The (int) and (string) does not appear in the HTML output.

sebsken commented 7 months ago

@buhtz put the type after the colon and it will work. arg1 : (int) description I seems another option could be arg1 : (int) : description but I have not tested it.