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

Use @relates to override documentation of friendship (Origin: bugzilla #648302) #4245

Open
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status NEW severity enhancement in component general for ---
Reported in version 1.7.4 on platform Other
Assigned to: Dimitri van Heesch

On 2011-04-20 14:06:32 +0000, David Ritter wrote:

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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment