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

Option for leaving the function parameter types empty for use with Breathe? #68

Open
Hecatron opened this issue Oct 4, 2019 · 1 comment

Comments

@Hecatron
Copy link

Hecatron commented Oct 4, 2019

Hi,
I've recently setup a python project, for the docs I'm using

python code -> Doxygen -> (filtered via doxypypy) -> Breathe -> Sphinx Docs

This all seems to work fine, however the types of function parameters are set to the same as the name in the XML output from Doxygen
What this leads to in the eventual html output is something like

read_makefile(self self)
write_makefile(self self, contents contents)

An example here

Since Breathe doesn't know it needs to ignore the types for python you just end up with the parameter doubled up such as "contents contents"
Ideally if doxypypy had an option for leaving the type field empty for function parameters then this would solve this.

@Hecatron
Copy link
Author

Hecatron commented Oct 7, 2019

For anyone else, I created a small script just to filter the types in the xml after the fact which seems to work quite well

https://github.com/Hecatron/py-makefile-dbparse/blob/master/docs/doxygen/filter_types.py

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