Doxygen Q&A

基本用法

接口注释

请参考官方文档，并且使用的语法需要与现有其他接口保持一致。

建议：

• 注释包含作者标识
• 数学公式使用LaTex描述
• 将不同类型的API正确地进行分组
• 编写必要的md文档来详细描述接口细节
• 及时更新所有文档，与代码实现保持一致

Markdown文档

在docs/目录下，建立你的md文件即可，doxygen处理时会自动为其生成HTML。

注意在首页或者其他什么位置，添加对这个文档的引用。否则只有Pages栏目下会列出所有自定义文档。

代码高亮

请参考docs/int8.md，示例格式如下：

~~~~~~{.c}
#include <stdio.h>
int main() {
    printf("hello, world\n");
}
~~~~~~

Markdown实际渲染效果如下：

#include <stdio.h>
int main() {
    printf("hello, world\n");
}

高级用法

MathJax公式

在代码注释中，使用一对"\f$" "\f$"括住公式内容即可。

MathJax语法请参考LaTex以及其官方文档。

接口分组功能

请参考官方文档，点此查看该功能生成文档接口分组的效果。

Markdown页面间引用

括号中ULR填写为md文件路径即可，例如：

- [Int8 Interface](docs/int8.md)

注释引用Markdown页面

在代码注释中直接使用上述语法即可：

[Go to this page](docs/YourPage.md)

其他支持的语法请参考这个回答。

Markdown引用Doxygen页面

括号中ULR填写为HTML文件名即可，例如：

- [API Documents](api_8h.html)

其他

自定义首页结构

编辑docs/DoxygenLayout.xml，字段含义请自行理解。

创建Index页面

请参考docs/index.md，让一级标题中后缀含有{#index}字样即可，例如：

# Main Page {#index}

PS: 这里一般无需改动。