Создайте новую пользовательскую команду, которая добавит раздел в Doxygen

Я хотел бы создать пользовательскую команду в Doxygen, похожую на fn param или var.

например, я хотел бы иметь возможность создать option команда, которую я бы использовал следующим образом:

/**
  option option_1 This is the first option.
  option option_2 This is the second option.
*/

С выходом, как:

варианты:
          option_1 это первый вариант.
          option_2 это второй вариант.




простой псевдоним подстановки не работает. Например, с этим псевдонимом:

ALIASES = option="par Options:n"

Я получаю следующий вывод:

варианты:
          option_1 это первый вариант.

варианты:
          option_2 это второй вариант.

это не то, что я ищу.

награда:

если требуется дополнительное разъяснение, см. Мой вопрос: Doxygen-создать пользовательскую команду

8
doxygen

2 ответов

хотя он не так чист, как @param, вы можете эмулировать подобное поведение со следующими псевдонимами:

ALIASES += options="<dl class="params"><dt>Options</dt><dd><table class="params">"
ALIASES += option{2}="<tr><td class="paramname"></td><td></td></tr>"
ALIASES += endoptions="</table></dd></dl>"

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

/**
 * @options
 * @option{ option_1, This is the first option. }
 * @option{ option_2, This is the second option. }
 * @endoptions
 */

Примечание: это HTML-ориентированный и, вероятно, не будет производить разумный выход для других форматов.

3

похоже, что xrefitem может сделать то, что вы хотите, как ответил на этот предыдущий вопрос: пользовательские теги с Doxygen

0