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

Question

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

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

}

应该产生这样一个列表：

List:
- A
  - B
    - C

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

谢谢

score 4 · Accepted Answer

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

我能够轻松地让缩进列表在块注释中工作：

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

切换到单行注释，它仍然有效：

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

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

score 2 · Accepted Answer

实际上可以使用 HTML 格式来做到这一点

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

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

2 回答 2