Добавление пользовательской команды в doxygen

Я хотел бы добавить пользовательскую команду в свою документацию по doxygen. По сути, для каждой функции C, для которой я пишу документ, мне нужно написать, какие глобальные переменные «касаются» в режиме чтения или в режиме записи. Это как список «Смотрите также», только с другим заголовком.

В моем файле я хотел бы написать что-то вроде этого:

/*
 * \read-globals   #var1, #var2
 *
 * \write-globals  #var3
 */

Я пробовал с таким псевдонимом:

read-globals = \par <b>Globals read</b>\n

Это работает, но я боюсь, что это не зависит от таблицы стилей: если завтра я захочу изменить css, то эта пользовательская команда сгенерирует вывод, который будет отличаться от см. также, автора и всех других разделов.

В основном я просто хочу скопировать формат из других стандартных команд.

Другой вариант — использовать команду \xrefitem, которая тоже работает, но требует ввода раздела в качестве второго параметра, что в моем случае совершенно бесполезно (может быть, его можно как-то скрыть?).

Есть ли «правильный путь» для достижения моей цели?


person Emiliano    schedule 30.10.2009    source источник


Ответы (1)


Вы можете комбинировать \xrefitem и ALIASES, если хотите скрыть второй параметр. Вот пример, который я использую для требований:

ALIASES += "req=\xrefitem req \"Requirement\" \"Requirements\" "

Затем в документированном коде:

/// \req #42 The system shall work in any situation

(из моего ответа на этот вопрос: Пользовательские теги с Doxygen)

person mouviciel    schedule 30.10.2009