Подтвердить что ты не робот

Как связать функции, не являющиеся членами, с классом в Doxygen?

Я уверен, что есть какой-то способ сделать это с тегами \defgroup,\addgroup и\@{\ @}, но после нескольких часов пробной и (явно) ошибки я спрашиваю SO.....

У меня есть:

class C {
public:
    void foo () const;
};

и у меня есть некоторые вспомогательные функции, не являющиеся членами, которые действительно являются частью интерфейса C, но не входят в класс:

std::string
format (const C& c, const std::string &fmt);

Я хочу, чтобы функция формата отображалась на той же странице, что и функции класса. Разве это невозможно? Лучше всего я могу сделать страницу "module", которая отображает C как класс (с гиперссылкой на комментарии C и формат как функцию?)

4b9b3361

Ответ 1

\ related (или\memberof) - это то, что вы ищете.

Ответ 2

Создание группы и назначение функций вне вашего класса в этой группе будут работать, но в самой документации по классу вы не будете получать ссылки на свои функции, если не используете такие команды, как @see или @sa. Честно говоря, потому что функция принимает документированный параметр, это не означает, что эта функция является автоматически частью библиотеки, но вы можете связать оба класса и функции вместе, используя @defgroup и @addgroup.