Sco*_*son 5 documentation doxygen documentation-generation
如果你把一个MainPage.dox文件放在Doxygen的搜索路径中,它会将它添加到源文档上方Doxygen/html的输出中.但是你有多个文件,如MainPage.dox？或者你只限于一个？
Doxygen将识别并解析任何具有*.dox扩展名的文件,并将其包含在生成的文档中.这些文件将产生的内容取决于文件中的doxygen注释.例如,如果要修改主页面,则需要注释如下:
/**
* @mainpage
* Documentation you want to occur on the main page.
*/
您还可以使用此技术创建应出现在其他页面上的文档:
/**
* @page another_page Another Page
* Documentation that will occur on another page.
*/
假设HTML输出,此表单将创建一个another_page.html与其相同级别的文件index.html.标题将是Another Page,并且引用的内容将遵循.还将生成一个名为的附加选项卡,该选项卡将Related Pages包含指向以此方式创建的所有相关页面的链接.
像这样的块可以出现在任何doxygen解析文件(包括头文件或源文件)中,并且可以包含多个页面的定义(上面的两个注释都可以在一个文件中).它们所在的文件对生成的输出没有影响.
| 归档时间： |
|
| 查看次数： |
6746 次 |
| 最近记录： |