Improve carputils Doxygen code documentation
I would like to discuss some propositions for improving the carputils Doxygen code documentation.
Here are some ideas I have implemented, but which could certainly be improved:
- Artificially group the scripts from the
binfolder in Doxygen, i.e. from this:
To this:
(At the end, I guess we would like to have only binandcarputils at the top level)
Pros: clearer separation between the carputils module and the executables that are not part of the module itself.
Cons: the way it's done causes Doxygen to add a bin prefix in functions, classes and variables documentation. I don't know if it is acceptable:
To
- Add description for the executables in the Doxygen documentation.
From:
To:
In terms of code:
From
#!/usr/bin/env python
"""
Generate a bullseye plot for given data.
"""To
#!/usr/bin/env python
"""
@package bin.bullseye
Generate a bullseye plot for given data.
"""These changes are implemented here
Do you think these changes could be integrated as is?