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 612458 - Documenting overloaded operator()(size_t) with copydoc does not work
Documenting overloaded operator()(size_t) with copydoc does not work
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
unspecified
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2010-03-10 18:27 UTC by David Ritter
Modified: 2012-11-18 11:13 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description David Ritter 2010-03-10 18:27:13 UTC
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.
Comment 1 Dimitri van Heesch 2010-04-13 18:58:35 UTC
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
Comment 2 Dimitri van Heesch 2010-06-15 11:22:06 UTC
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.