有没有办法在多个注释块中继续doxygen列表?

时间:2010-01-08 20:46:44

标签: documentation doxygen

基本上,我正在尝试按照以下方式执行文档代码:

//Description of Step 1
DoStep1_1();
DoStep1_2();
...
//Description of Step 2
DoStep2_1();
DoStep2_2();

我希望两个注释块在Doxygen输出中变成一个有序列表。我已经阅读了有关创建列表的文档,我知道我可以使用HTML标记,但看起来生成的标记之间会产生额外的东西,导致两个项目之间出现空白。最后,我不想使用HTML标签;也就是说,我更愿意使用

/*!
  -# Description of Step 1
*/
DoStep1_1();
DoStep1_2();
...
/*!
  -# Description of Step 2
*/
DoStep2_1();
DoStep2_2();

或类似的东西。这甚至可能吗?

修改 好的,所以我可能没有描述我得到的结果和我想要的结果。从上面的代码生成的HTML类似于:

  1. 步骤1的描述

  2. Step2的描述
  3. 请注意,我不想要2个段落标记,因为它们会导致不需要的空格。

1 个答案:

答案 0 :(得分:0)

当然这是可能的。我成功使用它。有关详细信息,请阅读我对该问题的回答:How to be able to extract comments from inside a function in doxygen?

编辑:在阅读了您的实际和预期结果后

不幸的是,我没有办法摆脱列表元素之间的空白。