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

Doxygen reports boost function object return type as attribute (Origin: bugzilla #677315) #4729

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

On 2012-06-01 23:15:51 +0000, taycode@gmail.com wrote:

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

On 2012-06-02 09:10:58 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2012-06-10 09:41:46 +0000, Dimitri van Heesch wrote:

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.

@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