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

Documenting overloaded operator()(size_t) with copydoc does not work (Origin: bugzilla #612458) #3701

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

On 2010-03-10 18:27:13 +0000, David Ritter wrote:

Given the following testcase:

/**

  • A string class that should be documented.
    */
    class RWCString
    {
    public:

/**

  • Index operator.
    */
    char& operator()(size_t i);

/**

  • @copydoc char& RWCString::operator()(size_t)
    */
    char operator()(size_t i) const

};

doxygen & copydoc do not appear to "see" the second overload. We have tried several variations of specifying the method signature that we are passing to copydoc, none of which worked.

This does not generate any error message, but it will not generate any documentation for the second overload.

On 2010-04-13 18:58:35 +0000, Dimitri van Heesch wrote:

Confirmed. I'll include your patch which should be included in the next subversion update.

Using the following should then suffice:

/**

  • @copydoc operator()(size_t)
    */
    char operator()(size_t i) const

On 2010-06-15 11:22:06 +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