Как связать функции, не являющиеся членами, с классом в Doxygen?
Вопрос
Я уверен, что есть какой-то способ сделать это с помощью тегов \defgroup, \addgroup и \@{ \@}, но после пары часов проб и (очевидно) ошибок я спрашиваю ТАК.....
У меня есть:
class C {
public:
void foo () const;
};
и у меня есть несколько вспомогательных функций, не являющихся членами, которые действительно являются частью интерфейса C, но не входят в класс:
std::string
format (const C& c, const std::string &fmt);
Я бы хотел, чтобы функция формата отображалась на той же странице, что и функции класса.Это просто невозможно?Лучшее, что я могу сделать, — это страница «модуля», на которой C указан как класс (с гиперссылкой на комментарии C и форматом как функция?
Решение
\связано (или \memberof), похоже, это то, что вы ищете.
Другие советы
Создание группы и назначение функций вне вашего класса в этой группе будет работать, но в самой документации класса вы не получите ссылки на свои функции, если не используете такие команды, как @see
или @sa
.Честно говоря, тот факт, что функция принимает документированный параметр, не означает, что эта функция автоматически является частью библиотеки, но вы можете связать классы и функции вместе, используя @defgroup
и @addgroup
.