如何使用Doxygen制作介绍页面

Question

我使用Doxygen为我的SDK制作了文档。它包含文件、名称空间、类、类型等的列表--我在代码中作为Doxygen注释放置的所有内容。现在我想写一些关于SDK的一般信息(某种介绍)，这些信息与任何代码元素都没有直接关系。我想把这个介绍放在文档的起始页上。我该怎么做呢？

Answer 1

看一看mainpage命令。

另外，看看另一个帖子的答案：How to include custom files in Doxygen。它指出，有三个扩展，doxygen类作为额外的文档文件：.dox，.txt和.doc。具有这些扩展名的文件不会出现在文件索引中，但可用于在最终文档中包含其他信息-对于必要但实际上不适合包含在源代码中的文档非常有用(例如，常见问题解答)

因此，我建议在您的项目目录中有一个mainpage.dox (或类似的名称)文件来介绍您的SDK。请注意，在此文件中，您需要放置一个或多个C/C++样式的注释块。

Answer 2

从v1.8.8开始，还有USE_MDFILE_AS_MAINPAGE选项。因此，请确保将索引文件(例如README.md )添加到INPUT，并将其设置为此选项的值：

INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md

Answer 3

请注意，使用Doxy1.8.0版本，您还可以添加Markdown格式的页面。为此，您需要创建具有.md或.markdown扩展名的页面，并将以下内容添加到配置文件中：

INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown

详情请参见http://www.doxygen.nl/manual/markdown.html#md_page_header。