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

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

Open Hecatron opened 4 years ago

Hecatron commented 4 years ago

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 commented 4 years ago

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