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

How to specify the type of an argument? #89

Open
buhtz opened this issue Mar 10, 2022 · 1 comment
Open

How to specify the type of an argument? #89

buhtz opened this issue Mar 10, 2022 · 1 comment

Comments

@buhtz
Copy link

buhtz commented Mar 10, 2022

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
Copy link

sebsken commented Jan 24, 2024

@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.

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

2 participants