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 677315 - Doxygen reports boost function object return type as attribute
Doxygen reports boost function object return type as attribute
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.1
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2012-06-01 23:15 UTC by taycode
Modified: 2012-06-10 09:41 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description taycode 2012-06-01 23:15:51 UTC
I have a header file containing:

class ClassName {
...

////////////////////////////////////////////////////////////////////////////////////////////////////
/// \fn boost::function<int(void *, char *)> ClassName::getFnPtr();
///
/// \brief ...
///
/// \author ...
/// \date ...
///
/// \return A boost function object ...
////////////////////////////////////////////////////////////////////////////////////////////////////

boost::function<int(void *, char *)> getFnPtr();

...
};

When running Doxygen, getFnPtr() is reported under "Public Attributes" instead of "Public Member Functions" even though the parentheses are present after the identifier.

Removing the \fn line from the comments causes the generated documentation to not include the brief text. With the \fn line the brief text is included in the generated documentation. Either way the member function is incorrectly documented under member attributes.

There is a Stack Overflow post about this:
http://stackoverflow.com/questions/10854344/why-is-doxygen-reporting-this-method-as-an-attribute
Comment 1 Dimitri van Heesch 2012-06-02 09:10:58 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 2 Dimitri van Heesch 2012-06-10 09:41:46 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1.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.