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 586925 - Python: Apostrophe in comments causes errors with \cond and \endcond commands while generating namespace docs
Python: Apostrophe in comments causes errors with \cond and \endcond commands...
Status: RESOLVED INCOMPLETE
Product: doxygen
Classification: Other
Component: general
1.5.9
Other All
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2009-06-25 08:45 UTC by Grzegorz Gacek
Modified: 2010-08-27 02:29 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Grzegorz Gacek 2009-06-25 08:45:32 UTC
Please describe the problem:
This bug is similar to bug #312322 - but it does not cause some parts of documentation to be missing, it causes errors with \cond and \endcond clauses. If those commands exists between odd and even occurences of apostrophes in Python comments they are not handled properly. 

Steps to reproduce:
Try to document file with following contents:

# This comment contains unpaired apostrophe: ' 

## Some namespace
# \namespace doxbug

## \cond DEVEL

## Brief description of DEVEL_func1
# This function is NOT documented properly, but as if "cond" command does 
# not exist.
def DEVEL_func1():
    pass

## \endcond

## Brief description of func2
# This function is documented properly
def func2():
    pass

# comment with second ', "closing" the pair
    
## \cond DEVEL

## Brief description of DEVEL_func3
# This function is documented properly
def DEVEL_func3():
    pass

## \endcond


Actual results:
Following errors can be seen in doxygen output:

Generating docs for namespace doxbug
D:/doxygen/doxbug.py:8: Warning: Found unknown command `\cond'
D:/doxygen/doxbug.py:15: Warning: Found unknown command `\endcond'
D:/doxygen/doxbug.py:8: Warning: Found unknown command `\cond'
D:/doxygen/doxbug.py:15: Warning: Found unknown command `\endcond'

DEVEL_func1 is included in the docs although ENABLED_SECTIONS configuration variable does not contain DEVEL section.

Expected results:
\cond and \endcond commands are recognized properly.

Does this happen every time?
Yes.

Other information:
It may be possible that this bug also applies to other commands but I'm unable to check that now.
Comment 1 Dimitri van Heesch 2010-07-12 19:41:49 UTC
I haven't been able to reproduce the problem with the example you provided.
Can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem?
Comment 2 Felipe Besoaín Pino 2010-08-27 02:29:06 UTC
Closing this bug report as no further information has been provided. Please feel free to reopen this bug if you can provide the information asked for.
Thanks!