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

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

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

/**
 \return return_self_reference
 */

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

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

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

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


documentation code-documentation documentation-generation doxygen
person Lehks    schedule 07.09.2018    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Для этих случаев у 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"

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

Результат

person albert    schedule 08.09.2018
comment
Большое спасибо, это было именно то, что я искал! - person Lehks; 08.09.2018