Создайте новую команду для добавления в раздел в Doxygen - PullRequest
9 голосов
/ 08 марта 2011

Я хотел бы создать пользовательскую команду в 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 Это второй вариант.

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

BOUNTY:

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

Ответы [ 2 ]

3 голосов
/ 28 декабря 2011

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

ALIASES += options="<dl class="params"><dt>Options</dt><dd><table class="params">"
ALIASES += option{2}="<tr><td class="paramname">\1</td><td>\2</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 и, скорее всего, не даст приемлемых результатов для других форматов.

0 голосов
/ 08 марта 2011

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

...