在连续的注释块之间保持doxygen中的列表缩进

时间:2013-03-28 15:01:35

标签: list doxygen indentation

我想在我的代码中使用Doxygen注释来创建项目符号列表,以补充生成的文档中的函数描述。 例如,以下代码段:

/**
 * Function x
 */
void function (void) {
/// List:
/// - comment A
;
;
/// + comment B
;
;
/// * comment C

}

应该产生这样的清单:

List:
- A
  - B
    - C

不幸的是,Doxygen似乎没有将缩进级别从一个注释块保持到同一个函数的另一个注释块。有解决方法吗?

由于

2 个答案:

答案 0 :(得分:3)

在研究过去几个小时之后,我得出的结论是,不可能在非连续的doxygen评论中缩进列表。

我能够轻松获得缩进列表以便在块注释中工作:

/**
-# Item 1
    -# Subitem 1
    -# Subitem 2
-# Item 2
*/

切换到单行注释,它仍然有效:

/// -# Item 1
///     -# Subitem 1
///     -# Subitem 2
/// -# Item 2

当我在单行注释中添加代码时,doxygen停止缩进子项。

答案 1 :(得分:2)

实际上可以使用HTML格式

来实现
//! <ul><li> Entering a condition:<ul>
if (xx)
{
    //! <li> something
    C=A+B;

    //! <li> something else
    D="lol";
}
//! </ul></ul>