Комментарии по умолчанию для Doxygen - PullRequest
Новая
       51

Комментарии по умолчанию для Doxygen

0 голосов
/ 08 сентября 2018

возможно ли определить что-то вроде макроса в Doxygen?

Я хочу написать комментарий примерно так: 

/**
 \return return_self_reference
 */

и Doxygen заменит return_self_reference на строку, определенную мной.

Комментарий, который затем будет прочитан Doxygen, будет следующим: 

/**
 \return A reference to the instance that the operator was called on.
 */

Обратите внимание, что, хотя я и назвал это макросом ранее, я не хочу определять макрос C или что-то подобное в реальном коде.

1 Ответ

0 голосов
/ 08 сентября 2018

Doxygen имеет для этих случаев параметр конфигурации ALIASES.

Давайте рассмотрим следующий пример: 

/** \file
  */


/**
 * \return the normal version
 */
int fie0(void);

/**
 * \return \str1_repl
 */
int fie1(void);

/**
 * \str2_repl
 */
int fie2(void);

и установите следующее ALIASES в файле конфигурации doxygen (дополнительные возможности ALIASES см. Также в руководстве): 

ALIASES                = "str1_repl=just the text in replacement" \
                         "str2_repl=\return return and the text in replacement"

и мы получим следующий результат:

Result

...