Answers:
看一下mainpage
命令。
另外,看看另一个线程的答案:如何在Doxygen中包括自定义文件。它指出,有三个扩展,并Doxygen的类作为附加的文档文件:.dox
,.txt
和.doc
。具有这些扩展名的文件不会显示在文件索引中,但可以用于在最终文档中包括其他信息-对于必需但实际上并不适合包含在源代码中的文档非常有用(例如,FAQ)
因此,我建议mainpage.dox
您在项目目录中有一个(或类似名称的)文件来介绍SDK。请注意,在此文件中,您需要放置一个或多个C / C ++样式注释块。
.md
和.markdown
)也被视为其他文档文件。我更喜欢它们,.dox
因为它们不需要周围的代码注释,并且可以使用markdown编辑器很好地进行编辑-没有缺点。
从v1.8.8开始,还提供了option USE_MDFILE_AS_MAINPAGE
。因此,请确保将索引文件(例如README.md)添加到INPUT
并将其设置为此选项的值:
INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
USE_MDFILE_AS_MAINPAGE
没有为我工作。根据文档,您必须{#mainpage}
在降价文档的标题之后添加。这确实有效。
INPUT = README.md
then INPUT += src
(遵循@Lester的建议),并且the USE_MDFILE_AS_MAINPAGE = README.md
就像一个魅力一样工作。版本:$ doxygen --version
回到1.8.11
我身边。
请注意,在Doxygen 1.8.0版中,您还可以添加Markdown格式的页面。为此,您需要创建带有.md
或.markdown
扩展名的页面,并将以下内容添加到配置文件中:
INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown
有关详细信息,请参见http://www.doxygen.nl/manual/markdown.html#md_page_header。
dox=md
为EXTENSION_MAPPING
并将您的markdown扩展名重命名为.dox
。因此配置如下所示:INPUT += your_page.dox EXTENSION_MAPPING += dox=md
以下语法可能有助于添加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"
*/
如下创建组也有助于设计页面:
/** \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.
*/
在文档中添加任何文件,其中将包含您的内容,例如toc.h:
@ mainpage Manual SDK
<hr/>
@ section pageTOC Content
-# @ref Description
-# @ref License
-# @ref Item
...
并在您的Doxyfile
:
INPUT = toc.h \
示例(俄语):
我尝试使用v 1.8.13进行上述所有操作均无济于事。(在macOS上)对我有用的是使用doxywizard-> Expert标签填充USE_MD_FILE_AS_MAINPAGE
设置。
它对我的Doxyfile进行了以下更改:
USE_MDFILE_AS_MAINPAGE = ../README.md
...
INPUT = ../README.md \
../sdk/include \
../sdk/src
请注意,对于的行终止INPUT
,我刚刚按照文档中的说明使用空格作为分隔符。AFAICT这是Doxyfile的无效版本与有效版本之间的唯一更改。