GNOME Bugzilla – Bug 641036
python script with #!/usr/bin/python are not documented correctly
Last modified: 2015-12-30 10:20:20 UTC
If you add #!/usr/bin/python at the beginning of your python script, the functions are not documented. Take the documentation example: """@package docstring Documentation for this module. More details. """ def func(): """Documentation for a function. More details. """ pass class PyClass: """Documentation for a class. More details. """ def __init__(self): """The constructor.""" self._memVar = 0; def PyMethod(self): """Documentation for a method.""" pass This example works and the "def func" function is documented. Now just add #!/usr/bin/python ....now the "def func" function is not documented and there's no "package" mention in the documentation. This is certainly a side effect of the first # in #!/usr...
Hi Pascal, I failed to reproduce this with the example you described, i.e. adding the #!/usr/bin/python did not make any difference. Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?
Created attachment 180641 [details] Example of issue Hi, You can find in the zip files: 2 python scripts used to generate the html documentation - html_ok is generated with example.py - html is generated with example_issue.py I have generated the documentation with doxygen v1.7.3 on windows host with the doxyfile.txt file provided. Warning: You have just to change the INPUT = to generate the required documentation. Br, Pascal.
Changed version 'latest' to '1.8.2-SVN' so I can remove 'latest' as an option as it is a moving target.
I've just pushed a proposed patch to github (pull request 427)
Changes have been integrated in github master version
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.8.11. Please verify if this is indeed the case. Reopen the bug if you think it is not fixed and please include any additional information that you think can be relevant (preferably in the form of a self-contained example).