在xrefitem别名中添加介绍性段落和编号

时间:2019-04-19 17:40:27

标签: latex doxygen

我已经使用doxygen别名来生成命令以生成带有列表的节。我想在每个部分中添加一个独特的介绍性段落。我的doxyfile中具有以下别名。

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

我想将其修改为:

  

可跟踪性

     

本节列出了每个给定测试的相关要求。

     
      
  1. 全局测试(SysTimerTest,StDelayUs)
  2.   
     

•Algovita-SWIT-137   •Algovita-SWT-650

     
      
  1. 全局测试(SysTimerTest,StCc0Isr)
  2.   
     

•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)
{
...
}    

0 个答案:

没有答案
相关问题