Doxygen - Создать собственную команду - PullRequest
1 голос
/ 08 августа 2011

Я думаю, что мой вопрос в основном такой же, как этот, но он не получил хорошего ответа: Создать новую пользовательскую команду, которая добавит в раздел в Doxygen

Я очень хочу сделать то же самое, я думаю. Я хочу полностью продублировать точную функциональность параметра @param, за исключением того, что вместо заголовка «Параметры» вместо него указывается заголовок «Параметры». Я хочу, чтобы аргументы были одинаковыми (тип данных, имя переменной и описание) и хочу, чтобы они выглядели одинаково и все. Буквально, единственное, что мне нужно, это заголовок.

Я тоже пытался это сделать:

ALIASES = option"\par Options:\n"

в моем Doxyfile, но я также получаю каждый отдельный параметр в своем собственном разделе, вместо того, чтобы все они были в одном разделе. Они также не имеют тех же аргументов, что и опция @param.

Я также пытался что-то сделать с \xrefitem, что, конечно, не сработало. Я попробовал это:

ALIASES = option="\xrefitem param \"Option\" \"Options\" "

но похоже, что \xrefitem используется для создания чего-то более похожего на скомпилированный список из разных разделов, например список Todo.

Помощь очень ценится. Спасибо!

<ч /> EDIT:

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

Опции:
string $ option1 Это вариант 1.
string $ option2 Это вариант 2.

Ответы [ 2 ]

0 голосов
/ 24 августа 2011

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

@par Options:
@li @e string @b $option1 This is option 1.
@li @e string @b $option2 This is option 2.

Это почти работает прилично, за исключением того, что оно не выстраивает каждую часть в хорошем состоянии, как это делает с @param,Таким образом, если имя первой опции имеет вид, подобный $option1, а имя второй опции - $thisIsTheSecondOption, начало описания не будет выстроено в очередь.Это больше похоже на:

Параметры: string $ option1 Это вариант 1. int $ thisIsTheSecondOption Это вариант 2.

Что затрудняет чтение.

: - \

0 голосов
/ 10 августа 2011

Я почти уверен, что это невозможно без модификации doxygen.Я бы просто использовал \ li и перечислил варианты вместо использования \ param.

http://www.doxygen.nl/manual/commands.html#cmdli

...