Generating documentation for python script with Doxygen

Question

I'm trying to create some documentation for some Python scripts included in my project (the rest is Fortran/C). I managed to include a brief and a detailed description for the files, but all the variables defined in the script are being listed in the documentation.

How do I avoid them from being listed? Which variable in the Doxyfile controls the inclusion of all the variables of a file?

How are you setting up Doxygen for your Python files? What are the specifics for your Python files? Are all your variables global? Are you using a Doxygen filter for Python like doxypypy? — Feneric
– Feneric, Commented Jul 18, 2016 at 19:57
My Python files are just scripts supposed to be launched interactively from the command line, with dynamic declaration of global variables (as a consequence in my doxygen documentation I get all the lines where a variable is declared for the first time). And yes, I'm using doxypy. — deandrade87
– deandrade87, Commented Jul 19, 2016 at 11:55

user3597719 · Accepted Answer · 2016-07-18 20:56:29Z

2

I had this similar problem while working with python-Doxygen. What worked for me is to enclose your variables between \cond and \endcond.

For example,

## \cond
some_var = "abc"
## \endcond

They won't show up in your documentation :)

answered Jul 18, 2016 at 20:56

user3597719

5771 gold badge5 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Generating documentation for python script with Doxygen

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related