List 在连续的注释块之间保持doxygen中的列表缩进
我想在代码中使用Doxygen注释来创建项目符号列表,以补充生成的文档中的函数描述。 例如,以下代码段:List 在连续的注释块之间保持doxygen中的列表缩进,list,doxygen,indentation,List,Doxygen,Indentation,我想在代码中使用Doxygen注释来创建项目符号列表,以补充生成的文档中的函数描述。 例如,以下代码段: /** * Function x */ void function (void) { /// List: /// - comment A ; ; /// + comment B ; ; /// * comment C } 应编制这样一份清单: List: - A - B - C 不幸的是,Doxygen似乎无法将缩进级别从同一函数的一个注释块保持到另一个注释块。有解决办
/**
* Function x
*/
void function (void) {
/// List:
/// - comment A
;
;
/// + comment B
;
;
/// * comment C
}
应编制这样一份清单:
List:
- A
- B
- C
不幸的是,Doxygen似乎无法将缩进级别从同一函数的一个注释块保持到另一个注释块。有解决办法吗
感谢在研究了过去几个小时后,我得出结论,在非连续的doxygen注释中缩进列表是不可能的 我能够轻松地使缩进列表在块注释中工作:
/**
-# Item 1
-# Subitem 1
-# Subitem 2
-# Item 2
*/
切换到单行注释,但仍然有效:
/// -# Item 1
/// -# Subitem 1
/// -# Subitem 2
/// -# Item 2
当我在单行注释之间添加代码时,doxygen停止缩进子项。实际上可以使用HTML格式进行缩进
//! <ul><li> Entering a condition:<ul>
if (xx)
{
//! <li> something
C=A+B;
//! <li> something else
D="lol";
}
//! </ul></ul>
/- 进入条件:
if(xx)
{
//什么
C=A+B;
//!- 还有别的吗
D=“lol”;
}
//!
类似地,当出现中断时,它甚至不会增加数字列表。看,这对我不起作用,我在生成过程中收到警告,我的列表没有被完全解析。