Doxygen - Создать пользовательскую команду

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

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

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

ALIASES = option"\par Options:\n"

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

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

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

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

Помощь приветствуется. Спасибо!

РЕДАКТИРОВАНИЕ:

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

Параметры:
строка $option1 Это вариант 1.
строка $option2 Это вариант 2.


command arguments doxygen param
person Travesty3    schedule 08.08.2011    source источник
comment
Я хочу сделать то же самое, за исключением текстовых ошибок. Возможно, более полное название вопроса могло бы привлечь больше ответов. Вы когда-нибудь отправляли запрос функции? Если так, то он не действовал 6 лет.   -  person msc    schedule 03.05.2017
comment
@msc: Извините, я не помню, открывал ли я запрос функции. Не стесняйтесь редактировать вопрос, если хотите, но я больше не ищу ответ на вопрос.   -  person Travesty3    schedule 04.05.2017

Ответы (2)


arrow_upward
0
arrow_downward

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

@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.

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

:-\

person Travesty3    schedule 24.08.2011
comment
Не могли бы вы опубликовать свои Псевдонимы для достижения этого результата? Я борюсь с той же проблемой. Довольно странно, что doxygen не допускает такого элегантного рендеринга. - person B Brendler; 06.07.2015
comment
@Bruno: Извините, этот пост был четырехлетней давности. Я на другой работе и больше не пользуюсь Doxygen. Я, честно говоря, почти ничего не помню об этом. Но я не помню, чтобы использовал какие-либо псевдонимы. Удачи! - person Travesty3; 07.07.2015

arrow_upward
0
arrow_downward

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

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

person Community    schedule 10.08.2011
comment
Изменение doxygen повлечет за собой загрузку исходного кода, его модификацию и компиляцию, верно? Вероятно, больше работы, чем я хочу сделать для этого. Возможно, я отправлю запрос функции. Используя \li, могу ли я создать заголовок для раздела из \li элементов, чтобы пользователь знал, что это Options? - person Travesty3; 10.08.2011