How to document friend injection functionality with doxygen?

Question

Given some code like in the following example:

class MyClass;

class Injector {
    /**
     * @brief MyClass addition.
     */
    friend MyClass operator+(MyClass a, MyClass b) { ... }
};

class MyClass: private Injector {};

How can I make doxygen include the documentation of operator+() on the documentation page of the MyClass class? Functionally it clearly belongs there. Is there some general way to make doxygen document functionality available through ADL?

A useful example in the real world: I'd like doxygen to include operators provided by the base classes in boost/operators.hpp.

albert · Accepted Answer · 2019-03-24 17:40:25Z

2

The /relates tag was designed for something close to that.

class MyClass;

class Injector {
    /**
     * @brief MyClass addition.
     * @relates MyClass
     */
    friend MyClass operator+(MyClass a, MyClass b) { ... }
};

class MyClass {};

This won't put the documentation on the same page, but will produce a "related functions" section on that same page, which links to the function.

http://www.doxygen.nl/manual/commands.html#cmdrelates

edited Mar 24, 2019 at 17:40

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Jun 16, 2014 at 21:19

Drew Dormann

65.4k14 gold badges133 silver badges200 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Tom De Caluwé Over a year ago

This does seem to be a straightforward approach, however it does not work in the case of boost/operators.hpp. How can I include documentation when the injector class is part of an external codebase?

Tom De Caluwé Over a year ago

Also, it doesn't work with the provided example. Doxygen keeps putting the docs with Injector (under the related section).

Collectives™ on Stack Overflow

How to document friend injection functionality with doxygen?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related