GNOME Bugzilla – Bug 621805
Documentation marker sequence //!< no longer works
Last modified: 2010-10-31 19:51:58 UTC
Created attachment 163851 [details] The source/header file containing the related part to be documented As of doxygen v1.7.0 the documentation marker sequence //!< seems no longer to be accepted for documenation after members as described in the doxygen docs. Without changing anything in my source code files running doxygen v1.6.3 on them succeeded whereas running doxygen v1.7.0 failed with following message lines in the warning log file: C:/Projects/Profile.h:24: Warning: Member CBP_LOAD_PROFILE (define) of group defCallBackParams is not documented. C:/Projects/Profile.h:23: Warning: Member CBP_SAVE_PROFILE (define) of group defCallBackParams is not documented. This behaviour is reproducable. v1.6.3 works, v1.7.0 doesn't. See the attached Profile.h file for the related source code part causing the above mentioned warnings. Moreover, you should notice, that for the "#define CBP_UNDEFINED" line no warning is generated even it is documented the same way. However, no final documention is created as well.
Created attachment 163852 [details] The extracted doxygen warning messages
FYI: Selected target output type is HTML.
Confirmed. Should be fixed in the next update.
This bug was previously marked ASSIGNED, which means it should be fixed in doxygen version 1.7.1. 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.
I'm still seeing this bug with Doxygen 1.7.1 and the /**< notation. System is Fedora 13 on x86_64.
But I'm seeing this for something like typedef struct { int value; /**< documentation } some_struct_t.
Sorry, have to extend the comment again, the documentation block _is_ terminated, so it is: typedef struct { int value; /**< documentation */ } some_struct_t.
Tim, can you please attach a self-contained example (source+config file in a tar or zip) that allows me to reproduce the problem? Since there are known issues using the 32bit version of doxygen on 64bit systems, please also mention if you use the i386 binary provided by me, the one provided by Fedora, or if you built it yourself.
I use the binary provided by Fedora. The code is available like this: git clone git://git.fawkesrobotics.org/fawkes.git cd fawkes make check The last command calls doxygen and will generate a file warnings.txt with the documentation errors. With 1.6.2 this produces no warnings. I think I've spotted some things that are correct errors (missing @return statements not detected in the old version), but the vast majority of the messages should be false, in combination with bug #625531. Since we use Doxygen to enforce complete documentation this is particularly painful to us and a fast release after a fix would be appreciated! Thanks for your help!
Seems to be fixed in 1.7.2.
Closing the bug. If you still see other appearances with version 1.7.2, please reopen and provide additional information.