Как связать функции, не являющиеся членами, с классом в Doxygen? - PullRequest
10 голосов
/ 02 ноября 2009

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

У меня есть:

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

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

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

Я бы хотел, чтобы функция форматирования появлялась на той же странице, что и функции класса. Это просто невозможно? Лучше всего я могу создать страницу «модуля», в которой C указан как класс (с гиперссылкой на комментарии C и отформатирован как функция?

Ответы [ 2 ]

13 голосов
/ 02 ноября 2009

\ related (или \ memberof), кажется, то, что вы ищете.

0 голосов
/ 02 ноября 2009

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

...