After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 312322 - Python comment with apostrophe causes parser to skip code
Python comment with apostrophe causes parser to skip code
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.4.x
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2005-08-02 08:37 UTC by MarkE
Modified: 2005-12-30 17:47 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description MarkE 2005-08-02 08:37:18 UTC
Please describe the problem:
While running doxygen over a python module, some portions of files were missing 
from the generated output.

Some experimentation revealed that a ## comment with an apostrophe in it like 
this:
## A comment with a ' in it
Meant that all subsequent code was skipped by the doxygen parser until another 
matching apostrophe was found like this:
## Another comment with a ' in it


Steps to reproduce:
1. Try to document this:

"""Problems with apostrophes"""
class Included(object):
    """I get included in doxygen"""
    pass

##This following apostrophe ' really messes things up for subsequent code

class NotIncluded(object):
    """I do not get included in doxygen"""
    pass

#This following apostrophe ' makes doxygen happy again

class IncludedAgain(object):
    """I get included in doxygen thanks to the apostrophe above"""
    pass


Actual results:
The "Included" class and the "IncludedAgain" class appear in the generated 
documentation. The "NotIncluded" class does not

Expected results:
The "Included" class, the "NotIncluded" class, and the "IncludedAgain" class 
should all appear in the documentation

Does this happen every time?
Yes

Other information:
Comment 1 Dimitri van Heesch 2005-12-04 15:04:59 UTC
Seems to be fixed in the latest CVS release. Can you verify this for me?
Comment 2 MarkE 2005-12-05 11:37:59 UTC
Unfortunately don't have easy CVS access. Upgraded to latest release version 
with no change.
Comment 3 Dimitri van Heesch 2005-12-30 17:47:39 UTC
This bug had the status ASSIGNED (which meant it was fixed, but not officially released), so now doxygen release 1.4.6 is out I've given it the status FIXED. 

Nevertheless, I would like to ask you to verify that this bug is indeed fixed in release 1.4.6. If not, then please reopen the bug.