Как я могу @ref другой вариант того же метода?

Question

Как я могу @ref другой вариант того же метода?

Я пишу комментарии для некоторого кода C ++. У меня есть две функции:

/** Some existing doxygen comment */
int foo(int x);

/** Another existing doxygen comment */
int foo(
this_signature y1,
is_really_long y2,
and_to_be_honest y3,
i_would y4,
really_rather y5,
avoid_repeating_it y6);

/** This is what I'm writing now */
int foo(double z);

В комментарии Doxygen для второй функции, я хочу сослаться, @ref, ко второй функции, точнее ко второму варианту функции. Как мне это сделать?

Примечание: меня особенно (не только бот) интересует решение, которое не будет слишком многословным (учитывая длинную сигнатуру второй функции).

3

c++comments cross-reference documentation doxygen

Решение

Другие решения

Других решений пока нет …

Источник

Accepted Answer

На него (как писал @Scheff) можно ссылаться с помощью подписи. Так что-то вроде:

/** Fie to show reference:
*
* \ref foo(unsigned long)
*
* \ref foo(unsigned long y)
*/
void fie(void);

Смотрите также http://www.doxygen.nl/manual/autolink.html#linkfunc.

Что касается комментариев по поводу длинных подписей, либо используйте \anchor возможность, предложенная @Scheff, хотя, на мой взгляд, на первый взгляд это выглядит хорошим решением, но оно менее обслуживаемо (вариант подписи проверяется на наличие при создании документации, но строка в \ref из \anchor нет (и вам, вероятно, понадобится что-то вроде: \ref my_anch "foo(unsigned long y)" как иначе (\ref my_anch) ссылка будет иметь название my_anch ,

2