GNOME Bugzilla – Bug 615755
Erroneous parsing of C++ comment headers that contain quotation marks
Last modified: 2010-06-15 11:22:15 UTC
Created attachment 158728 [details] 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.
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
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.