如何用Doxygen制作介绍页面
我使用Doxygen为我的SDK制作了文档。 它包含文件,命名空间,类,类型等的列表 - 我在Doxygen注释中放置的所有代码。 现在我想写一些有关SDK(一种介绍)的一般信息,它不直接与任何代码元素相关。 我想把这个介绍放在文档开始页面上。 我怎样才能做到这一点?
看看mainpage
命令。
另外,看看这个答案的另一个线程:如何在Doxygen中包含自定义文件。 它指出有三个扩展名,它们是doxygen类作为附加文档文件: .dox
, .txt
和.doc
。 具有这些扩展名的文件不会出现在文件索引中,但可用于在最终文档中包含其他信息 - 对于必要的文档非常有用,但对于包含在源代码中的文档来说非常有用(例如FAQ)
所以我建议在你的项目目录中有一个mainpage.dox
(或者同样命名的)文件来向你介绍SDK。 请注意,在此文件中,您需要放置一个或多个C / C ++样式的注释块。
请注意,在Doxygen 1.8.0版本中,您还可以添加Markdown格式的页面。 为此,您需要创建带.md或.markdown扩展名的页面,并将以下内容添加到配置文件中:
INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown
有关详细信息,请参阅http://www.doxygen.org/markdown.html#md_page_header。
从v1.8.8开始,还有USE_MDFILE_AS_MAINPAGE
选项。 因此,请确保将您的索引文件(例如README.md)添加到INPUT
并将其设置为此选项的值:
INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
链接地址: http://www.djcxy.com/p/20143.html