如何与Doxygen做一个介绍页面
我使用Doxygen为我的SDK制作了文档。 它包含文件，命名空间，类，types等的列表 – 我把所有的东西放在代码中作为Doxygen注释。 现在我想写一些关于SDK（一种介绍）的一般信息，它不直接与任何代码元素相关。 我想把这个介绍放在文档开始页面上。 我怎样才能做到这一点？
看看mainpage命令。
另外，看看这个答案的另一个线程： 如何在Doxygen中包含自定义文件 。 它指出，有三个扩展名doxygen类作为附加的文档文件： .dox ， .txt和.doc 。 具有这些扩展名的文件不会出现在文件索引中，但可以用来在最终文档中包含附加信息 – 对于必要的文档非常有用，但对于包含在您的源代码中的文档并不适合（例如FAQ）
所以我build议在你的项目目录中有一个mainpage.dox （或者同样命名的）文件来向你介绍SDK。 请注意，在这个文件中，您需要放置一个或多个C / C ++样式的注释块。
请注意，在Doxygen 1.8.0版本中，您还可以添加Markdown格式的页面。 为此，您需要创build带.md或.markdown扩展名的页面，并将以下内容添加到configuration文件中：
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
在包含您的内容的文档中添加任何文件，例如toc.h
@ mainpage Manual SDK <hr/> @ section pageTOC Content -# @ref Description -# @ref License -# @ref Item ...
在“doxyfile”
INPUT = toc.h \
示例手册（俄语）
http://www.scale-tech.ru/luckyBackupW/doc/html/index.html
http://www.scale-tech.ru/luckyBackupW/doc/html/toc_8h_source.html
以下语法可能有助于为doxygen添加主页面和相关子页面：
/*! \mainpage Drawing Shapes * * This project helps user to draw shapes. * Currently two types of shapes can be drawn: * - \subpage drawingRectanglePage "How to draw rectangle?" * * - \subpage drawingCirclePage "How to draw circle?" * */ /*! \page drawingRectanglePage How to draw rectangle? * * Lorem ipsum dolor sit amet * */ /*! \page drawingCirclePage How to draw circle? * * This page is about how to draw a circle. * Following sections describe circle: * - \ref groupCircleDefinition "Definition of Circle" * - \ref groupCircleClass "Circle Class" */
如下创build组还有助于devise页面：
/** \defgroup groupCircleDefinition Circle Definition * A circle is a simple shape in Euclidean geometry. * It is the set of all points in a plane that are at a given distance from a given point, the centre; * equivalently it is the curve traced out by a point that moves so that its distance from a given point is constant. * The distance between any of the points and the centre is called the radius. */
一个例子可以在这里find
