Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

python script with #!/usr/bin/python are not documented correctly (Origin: bugzilla #641036) #4129

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.8.2-SVN on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2011-01-31 15:13:48 +0000, pascal.couteau@gmail.com wrote:

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...

On 2011-02-08 20:55:52 +0000, Dimitri van Heesch wrote:

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?

On 2011-02-11 10:09:13 +0000, pascal.couteau@gmail.com wrote:

Created attachment 180641
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.

On 2012-11-18 11:08:08 +0000, Dimitri van Heesch wrote:

Changed version 'latest' to '1.8.2-SVN' so I can remove 'latest' as an option as it is a moving target.

On 2015-12-25 18:44:09 +0000, albert wrote:

I've just pushed a proposed patch to github (pull request 427)

On 2015-12-26 18:50:49 +0000, albert wrote:

Changes have been integrated in github master version

On 2015-12-30 10:20:20 +0000, Dimitri van Heesch wrote:

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).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.