文章目录
- 创建章节和子章节
- 配置 doxygen
Doxygen 不直接支持 Markdown 的 [toc]
语法。但是,你可以通过以下步骤手动创建目录:
创建章节和子章节
在 Markdown 文件中,使用标题标记( # )来创建章节和子章节。
Note:
- markdown 文件的一级标题会被 doxygen 当做页面标题显示
如果想给 markdown 文件重命名一个页面标题,可以使用下列语法
@page my_page My Page
This is the content of my custom page
page_name
是页面的名称,用于在文档中唯一标识该页面。Page Title
是页面的标题,将会在生成的文档中显示。Page content goes here
是页面的内容,可以包含任意的文本、标记和注释。
@page Example_ADC ADC
这样在页面显示的就是 ADC
标题,而不是 Example_ADC
子页面引用时使用
@subpage Example_ADC
引用的是页面名称,而不是页面标题
配置 doxygen
支持 markdown
配置HTML 输出
这样,Doxygen 将会根据 Markdown 文件中的标题标记生成一个树形结构的目录。生成的目录将会出现在 Doxygen 生成的 HTML 或其他格式的文档中,而不是在 Markdown 文件本身中。