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

Erroneous parsing of C++ comment headers that contain quotation marks (Origin: bugzilla #615755) #3738

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.6.3 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-04-14 16:12:08 +0000, Brian Taylor wrote:

Created attachment 158728
A C++ file that triggers the error, and my .doxygen file.

Version: 1.6.3
uname -a = Linux zen2 2.6.11.4-20a-default # 1 Wed Mar 23 21:52:37 UTC 2005 x86_64 unknown unknown GNU/Linux
OS: SuSe Linux 9.3

A C++ comment header that contains quotation marks '"' is parsed incorrectly, causing doxygen to complain that a documented parameter is undocumented.

The following input:

class Test {
public:
/*! \param [in] first Description containing '"'

  • \param [in] second Description containing '"'
    */
    void foo(char first = '"', char second = '"');
    };

Causes the following warning:

/path/to/test.h:3: Warning: The following parameters of Test::foo(char first='"', char second='"') are not documented:
parameter 'second'

I have attached a *.tar.gz containing a C++ file which triggers the bug as well as my .doxygen configuration file.

On 2010-04-14 19:25:01 +0000, Dimitri van Heesch wrote:

The problem is that text with double quotes has a special meaning for doxygen (i.e. a piece of verbatim text).

I've already added a couple of heuristics to avoid false detections. I'll improve these such that also your example is handled properly.

As a workaround use:

/*! \param [in] first Description containing '"'

  • \param [in] second Description containing '"'
    */

Doxygen will remove the 's

On 2010-06-15 11:22:15 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.0. 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.

@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