如何使用Doxygen制作简介页 [英] How to make an introduction page with Doxygen

问题描述

我使用Doxygen为我的SDK制作了文档。它包含文件，名称空间，类，类型等的列表-我在代码中作为Doxygen注释放置的所有内容。现在，我想写一些关于SDK的常规信息（介绍的种类），它与任何代码元素都不直接相关。我想将此介绍放在文档起始页上。我该怎么做？

I made documentation for my SDK, using Doxygen. It contains the list of files, namespaces, classes, types etc. - everything that I placed as Doxygen comments in the code. Now I want to write some general information about SDK (kind of introduction), which is not related directly to any code element. I want to place this introduction on the documentation start page. How can I do this?

推荐答案

看看 主页 命令。

另外，请看一下对另一个线程的答案：如何包括Doxygen中的自定义文件。它指出了doxygen类作为附加文档文件的三个扩展： .dox ， .txt 和 .doc 。具有这些扩展名的文件不会出现在文件索引中，但可以用于在最终文档中包括其他信息-对于必需但实际上并不适合包含在源代码中的文档非常有用（例如，FAQ）

Also, have a look this answer to another thread: How to include custom files in Doxygen. It states that there are three extensions which doxygen classes as additional documentation files: .dox, .txt and .doc. Files with these extensions do not appear in the file index but can be used to include additional information into your final documentation - very useful for documentation that is necessary but that is not really appropriate to include with your source code (for example, an FAQ)

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

So I would recommend having a mainpage.dox (or similarly named) file in your project directory to introduce you SDK. Note that inside this file you need to put one or more C/C++ style comment blocks.

这篇关于如何使用Doxygen制作简介页的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！