Пользовательский тег Doxygen с заполнителем - PullRequest
Новая
       14

Пользовательский тег Doxygen с заполнителем

0 голосов
/ 14 февраля 2019

Возможно ли как-то в Doxygen создать собственный тег, который создает документацию с использованием тега-заполнителя в качестве входных данных?

Что я хочу сделать, это создать собственный тег для требований.Поскольку наши URL DOORS довольно длинные и расходятся от SW-компонента к SW-компоненту, я хочу создать что-то похожее на это: 

@file somefile.c
@doorsdocurl <URL to DOORS document> -> this is going to be my placeholder

...
...
...


/**
* @brief somedescription
* @req{doorsdocurl: <reqID1, reqID2,...> } -> this is going to be the second custom tag
*/
void jambo()
{
}

Достигается ли это как-то с помощью Doxygen?Из того, что я прочитал, нужно поместить его пользовательские теги в переменную ALIASES

1 Ответ

0 голосов
/ 14 февраля 2019

В вашем Doxy-файле вам понадобится что-то вроде: 

ALIASES = "doorsdocurl_sw_1=<URL to DOORS document>" \
          "req{2}=\1 \2<br>"

, а код будет выглядеть так: 

/**
* @brief somedescription
*
* @req{@doorsdocurl_sw_1,reqID1}
* @req{@doorsdocurl_sw_1,reqID2}
*/
void jambo()
{
}

Команда \req, конечно, может быть расширена другими командамив этом отношении может быть полезна команда xrefitem, см. руководство (http://www.doxygen.nl/manual/commands.html#cmdxrefitem)

...