如何获取主页的手册页输出?

时间:2013-04-25 02:18:11

标签: doxygen

Doxygen允许您生成手册页输出,但据我所知它只生成实际代码(函数,类等)的手册页。我在doxygen @mainpage注释中有大量信息,例如示例,这些注释未显示在手册页输出中的任何位置。我希望以这种格式使用它,以便我还有一个手册页作为整体介绍。有没有办法用doxygen做到这一点?

到目前为止,我还没有找到方法,而且我探索过的替代方法与doxygen为我创建的index.html文件无法很好地协作。例如,我在index.html文件上尝试了几个不同的html2man脚本但没有成功。

3 个答案:

答案 0 :(得分:1)

我提出了这个解决方法,它将伪主页文本放在手册页中,并从HTML主页中为它添加一个很好的链接:

/**
 * @mainpage
 * Summary of my simple project.  Please see @ref foo.h for more details.
 *
 * @file foo.h
 * @brief Summary of my simple project.
 * 
 * Here is the much more detailed description of my project,
 * originally intended for the main page.  Since I value the quality
 * of man page output the most, this will end up on the individual
 * file man page, and will be linked to from the HTML main page.
 * I can rattle on with other things like...
 * @todo find a better solution to the mainpage problem.
 */

答案 1 :(得分:0)

您是否在包含@file <filename>文档的文件中添加了@main条评论,且<filename>是否与实际文件名完全匹配?

Doxygen将不包含至少没有此文件的文件。

http://www.doxygen.nl/manual/commands.html#cmdfile

答案 2 :(得分:0)

据我所知,这是不可能的。 HTML输出涵盖整个项目,而手册页输出涵盖单个@file。 @mainpage适用于整个项目,而不是任何特定的@file。因此doxygen不输出人工输出的@mainpage。

我下载了源代码,并浏览了src / layout.cpp。搜索(例如)BriefDesc,您将看到每个&#34;布局处理程序&#34;放在一起。我还没有理解@mainpage映射到的内容,但显然它并没有在&#34;文件布局处理程序中添加的东西&#34;部分。

我尝试添加@mainpage或@page,并使用@ref引用它,看看我是否可以创建2个手册页并手动将它们绑在一起,但仍然有一个漂亮的HTML首页。例如,我试图获得2个手册页,foo和foo-intro。要做到这一点,我需要@page。但对于HTML输出,介绍显示在&#34;相关页面&#34;而不是&#34;主页面&#34;。然而@mainpage似乎无法触发单独的手册页。不理想。