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

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

0 голосов
/ 22 октября 2018

Я пишу комментарии для некоторого кода 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, на вторую функцию или, скорее, на второй вариант функции.Как мне это сделать?

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

1 Ответ

0 голосов
/ 22 октября 2018

На него (как писал @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.

...