Я использовал псевдоним doxygen для создания команд, которые генерируют разделы со списками в них. Я хочу добавить уникальный вводный абзац в каждый раздел. У меня есть следующий псевдоним в моем докси-файле.
ALIASES +="trace=\xrefitem trace \"Trace\" \"Traceability\""
Создает раздел, который выглядит следующим образом:
Traceability
Global TEST (SysTimerTest, StDelayUs)
• Algovita-SWIT-137
• Algovita-SWT-650
Global TEST (SysTimerTest, StCc0Isr)
• Algovita-SWIT-137
• Algovita-SWT-655
Я хочу изменить его так:
Отслеживание
В этом разделе перечислены соответствующие требования для каждого данного теста.
- Глобальное ТЕСТ (SysTimerTest, StDelayUs)
• Algovita-SWIT-137
• Альговита-SWT-650
- Глобальный тест (SysTimerTest, StCc0Isr)
• Algovita-SWIT-137
• Algovita-SWT-655
Для нумерации я попытался добавить - # несколько разных способов к строке псевдонима, но я не смог получить ее для нумерации.
Для начала абзаца я попытался использовать
\addtogroup knownIssues
\@{
This section lists the associated requirements for each given test.
@}
но это сделало второй раздел известных проблем, содержащий абзац. Он не помещался в раздел известных проблем, сгенерированный \xrefitem
.
Трассировка используется для документирования исходного кода. Пример заголовка с его использованием выглядит так:
/**
* @test
* Validates that the chipcom event manager is called as part of the main event loop.
*
* @trace
* - Algovita-SWIT-210
* - Algovita-SWIT-1738
* - Algovita-SWT-783
*
* @testMethod
* Call main() function with bluetooth stack initialized and not initialized.
*
* @acceptanceCriteria
* - Validate that the gecko_peek_event() function is called for both cases.
*/
TEST(BgmApplication, callChipcomEventManager)
{
...
}