doxygen - 如何使用 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++ 风格的注释 block 。