Description
Good morning,
I would like to report what seems to be a bug related to doxygen.
The thing is that I want to document a Python script using Python docstrings, enclosed between """! .... """ These Python docstrings are typed next to the shebang line and a set of lines that include SLURM directives (necessary to submit the script through "sbatch").
The problem is that "doxygen" does not interpret the documentation, so, when it generates the html documentation, the information contained in the docstrings does not appear.
This is how the code looks:
And the doxygen html documentation:
You can see that the filename "03_y_x_subdomain_coord.py" appears in black, so I can't click on it, and no content is included.
However, if I type the Python docstrings before the SLURM directives, doxygen interprets them well (but in this case SLURM does not interpret the directives).
This is the situation:
And the doxygen html documentation:
So, for some unknown reason, "doxygen" is not able to interpret Python docstrings (enclosed between """! ... """) when they are typed next to SLURM directives.
Finally, just tell you that when you use Python docstrings enclosed in the native doxygen manner (that is, enclosed between ## .... ##) then, "doxygen" interprets correctly the docstrings, even if they are typed next to the SLURM directives.
This is how the code looks when using native way of enclosing docstrings:
For all these reasons, I think that maybe there is a bug in doxygen about the interpretation of Python docstrings (enclosed in Pythonic way, """! .... """) when they are typed after SLURM directives.
doxygen used version is: 1.9.5
Hope to have explained well the problem.
Regards,
Joan