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 648302 - Use @relates to override documentation of friendship
Use @relates to override documentation of friendship
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: general
1.7.4
Other All
: Normal enhancement
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2011-04-20 14:06 UTC by David Ritter
Modified: 2018-07-30 10:16 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description David Ritter 2011-04-20 14:06:32 UTC
It would nice to be able to use the @relates markup (or another) to override the documentation of a friendship.  Even though a method is a friend of another I have a scenario where I would prefer to document it on another class.

For example the following code:

/**
 * First test class that should be documented.
 */
class TypeOne
{
public:

private:
  friend TypeOne toTypeOne(const TypeTwo& two);

  // Hide this constructor for internal use.
  TypeOne(int i);

};

/**
 * Second test class that should be documented.
 */
class TypeTwo
{
public:

  TypeTwo();

};

/**
 * @relates TypeTwo
 * 
 * Populates a TypeOne from a TypeTwo.
 */
TypeOne
toTypeOne(const TypeTwo& two);

will document the method toTypeOne on the class TypeOne even though the relates tag requests it be documented with TypeTwo (which is the indicated preference).
Comment 1 André Klapper 2018-07-30 10:16:37 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!