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: Apostrophe in comments causes errors with \cond and \endcond commands while generating namespace docs (Origin: bugzilla #586925) #3433

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

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

On 2009-06-25 08:45:32 +0000, Grzegorz Gacek wrote:

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.

On 2010-07-12 19:41:49 +0000, Dimitri van Heesch wrote:

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?

On 2010-08-27 02:29:06 +0000, Felipe Besoaín Pino wrote:

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!

@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