Demonstrating bugs in doxygen generation for python
This repository contains a sample python project to demonstrate some unexpected behaviour, when generating documentation for python.
This demonstration needs python and some packages installed.
You can install python and pip on Ubuntu by executing the following script:
./install_python.shIf you just installed python and installed your first packages please reboot your machine.
To install the script requirements execute
./install_dependencies.shplease execute following command to run doxygen for the project from the root of this repository:
doxygen .doxyfileit will produce the documentation in ./docs/doxygen
If you look into the generated Class Hierarchy you will find MathOperation twice.
Because of using the package aproach with __init__.py doxygen doesn't correctly detect the dependency between interface and implementations.
Expected Behaviour:
properly detect the connection between interfaces and implementations
If you look into the ComplexNumber class there won't be any members. The @dataclass annotation in the python file will generate the fields but doxygen doesn't show them.
Expected Behaviour:
display the members that are defined for the dataclass