使用Doxygen生成单文件HTML文档
Doxygen可以将HTML文档创建为一个非常长的文件吗？我想要像RTF输出，但是作为HTML。 原因：我需要我的API作为一个可打印的文档发布。可以加载到Word中的东西，转换为PDF等。 谢谢。 解决方案/ div> 我想您可以使用 HTMLDOC 转换生成的html文件到一个单一的html文件。 （我没有尝试自己） 手册包含以下两个源代码html文件生成html的例子：
..
doxygen相关内容
如何在HTML Doxygen中指定图像大小？
我试图手动指定由Doxygen生成的HTML中的图像大小。但是，在我阅读文档时，只能在使用LaTeX输出。这里的任何人都知道有任何解决方法吗？ 举个例子，我想这样做： \image html example.png“Caption”width = 10px 谢谢！ 解决方案 将其放在CSS文件“Doc / doxygen_html_style.css”中：
..
Doxygen和Objective-C类
尽管Doxygen的最新版本声称更好地处理Objective-C类别，似乎在我的源代码中阻止类别。我想知道有人是否已经得到了正确的文档分类。 作为一个例子，我有一个NSString类别定义为： @interface NSString（CCFExtensions） 使用一个名为NSString_CCFExtensions.h的接口文件和实现文件NSString_CCFE
..
Doxygen不记录静态类？
最近我一直在使用Doxygen作为我的一个项目。我有一个问题，但它不会为C＃静态类生成正确的文档。有没有一些选项我必须启用？ 我的相关课程的完整源代码是此处。而命名空间的doxygen文件列在此处。此外，我的Doxyfile是此处。它是由doxywizard使用几乎默认的设置生成的。 如您所见，该类的简短描述是生成的，但该类没有一个页面可以看到（记录）静态方法和成员。而且，类没有列在类
..
用doxygen记录：把细节放在顶部
我正在使用doxygen作为Android项目的文档。自从多年以来，我知道doxygen。但是现在我有这个问题，我想要我的类的细节，就像在javadoc中的顶部而不是底部。 在一个简短的Google搜索之后，我发现了这个选项 DETAILS_AT_TOP 这将只是做我想要的，但遗憾的是，此选项被删除。所以新的方法是使用所谓的 DoxygenLayout.xml ，但该文件的文档在哪里应该是什
..
Doxygen：组模块和页面？
我有一个有关doxygen的页面和组的问题。 我有一个项目，我在那里我分组了类别等与 @defgroup 和 @ingroup cmds。到目前为止这个工作正常。 现在我想使用markdown页面为项目添加特殊文档。这些页面应显示在专用模块（组）中。我尝试使用 @page 和 @subpage cmds创建页面。这很好，但这些页面在菜单中显得很简单。 所以我试图将它们添加到具有 @i
..
Eclipse的悬停提示可以从头文件中显示Doxygen注释吗？
我正在使用Eclipse CDT来编写C ++代码。在StackOverflow上阅读了关于是否将doxygen文档放在头文件或实现文件中的几个讨论，似乎大多数开发人员倾向于将doxygen注释放在头文件中（虽然当然不是共识）。但是，如果我将doxygen注释放在我的头文件中，当我将鼠标指针悬停在注释方法/成员的一个实例上时，我无法让Eclipse显示这些注释。有没有办法让Eclipse在Ecli
..
doxygen是（事实上）标准文档语法规范吗？
我们都有记录我们的代码的好习惯，对吧？ 现在，代码内的文档本身有一个语法。它几乎像一个编程语言本身。问题是： 存在什么（多少）文档语法规范 是否有标准的文档语法？ 谁定义了这个标准？是否有官方委员会或机构（像定义C ++标准一样）？ 还是有“doxygen”成为事实上的标准？ 听说过doxygen。在我参与的每个开源软件项目中都提到了，但是看官方的doxygen网站，很显然
..
如何从doxygen函数中提取注释？
我有兴趣知道是否有可能在函数（c，c ++，java）中有一些注释，方法是doxygen可以将它们放在生成的html文件中。 例如： function（...） { do_1 ）; / ** *调用do_2函数进行特定的操作。 * / do_2（）; } 解决方案 不，doxygen不支持评论阻止功能体内部。从手册中： Dox
..
Doxygen并将一个属性的值添加到输出文档
ServiceStack 标记使用c＃属性的Web服务的休息路径。 例如 [RestService（“/ hello1”）] [RestService（“/ hello2”）] public class Hello 想让Doxygen在Hello类的doxygen输出中包含RestService属性的值。如果带有括号的全部行包含在输出文档中，我并不关心如何使
..
在Visual Studio 2010中使用doxygen
与“un / comment lines”相比，没有其他功能可以进行评论。例如生成注释存根，在新行之后添加///。 另外，我想知道在VS2010的IntelliSense功能中显示这些注释需要什么？ 解决方案 根据 MSDN文档，任何使用 // 或 / * 分隔符的注释将显示在智能感知成员列表中的关联成员旁边。 / p> 您可以使用doxygen的XML输出或。 / do
..
是否存在“维基”用于编辑doxygen评论？
我正在开发一个相当大的开源RTS游戏引擎（ Spring ）。我最近添加了一些Lua调用的新的C ++函数，并且想知道如何最好地记录它们，同时也刺激人们为现有Lua调用的很多编写/更新文档，出来。 所以我认为如果我最初可以用C ++函数附近的doxygen来编写文档可能会很好 - 这很容易，因为函数体显然定义了什么该功能是。然而，我希望游戏开发人员使用引擎来改进文档，引擎通常对git（我们使
..
如何获得完整的智慧工具提示评论工作？
我有一些C ++ / CLI软件，这些都很好，记录在一个C＃'ish的方式，这意味着DOxygen能够把它拉出来一些很好的html。有没有什么方法可以得到相同的信息，以显示在智能感知工具中提示.net框架的方式？ 例如，让我们说这是我的标题文件（MyApp.h）： / *************** MyApp.h *************** / ///我包含所有我的fu
..
问问Doxygen在C中记录一个枚举
我在Doxygen（1.6.1在Mac OS X Snow Leopard）上有一个相当奇怪的问题，因为它似乎没有记录我的枚举，无论我做什么。我在C编程，并按照手册中的说明进行操作。这是我的代码： / ** * \enum dccp_pkt_type * \brief指定可用的DCCP数据包类型 * / enum dccp_pkt_type { DCCP_REQUE
..
如何将示例与Doxygen集成？
我记录了我的所有课程，现在我想集成一个如何使用这些类的例子。我怎么做？ 解决方案 您可以将示例源代码放在doxygen配置中定义的特殊路径下， EXAMPLE_PATH ，然后插入示例与 @example 标签。 然后，Doxygen将生成一个额外的包含示例的源的页面。它还将从包含示例标签的类文档中设置一个链接。 或者，如果要使用小代码片段，可以使用 @code ... @en
..
一个doxygen eclipse插件自动生成存根文档？
我正在寻找一个用于doxygen代码文档的eclipse插件。我发现了eclox-plugIn（ http://home.gna.org/eclox/ ） 。我想知道如何自动生成一个“空的”doxygen注释，可以稍后填写，或者是什么是更好的选择文档eclipse插件？ 例如对于函数：void f（int p1，int p2，...），它应该生成： *！ \brief ... \
..
建议一个好的Doxygen样式表
我使用Doxygen从我的代码生成HTML文档。然而，我发现默认样式表的字体和布局选择相当差。我知道我可以编写自己的CSS文件来获得我想要的输出，但是在我花费我的时间之前，我想知道是否有可用的体面的自定义样式表。 解决方案 我对Doxygen CSS进行了一些基本的修改，以清理它。我已将其上传到 bitbucket.org/rc1/doxygen-style/
..
使用Doxygen与C，你评论功能原型或定义？或两者？
我使用Doxygen与一些嵌入式C源。给定一个.c / .h文件对，是否将Doxygen注释放在函数原型（.h文件）或函数定义（.c文件）上，或者在两个地方复制？ 我有一个问题，当我在一个地方而不是另一个地方记录时，Doxygen正在警告错误的注释;这是预期的，还是我的Doxygen搞砸了？ 解决方案 对于公共API，我在声明中记录，因为这是如果没有使用doxygen输出，用户通常会
..
记录c ++中使用的C ++ / CLI库代码 - 最佳工具和实践？
我正在开发一个项目，其中一个c ++ / cli库主要来自ac＃应用程序。有没有办法让代码注释c ++ / cli可视化视觉工作室内的c＃intellisence？ 假设没有，最好的方法是记录c ++ / cli代码以使其更容易使用从c＃（当然还有c ++ / cli）？你对XML评论和doxygen与其他工具（哪个）有什么意见？ 解决方案 我已经得到如下工作： 为C ++ /
..
Doxygen vs Javadoc
我刚从CACM的一篇文章中发现，Doxygen与Java（和其他几种语言）一起工作。但Java已经有Javadoc工具。有人可以解释一种方法的利弊是什么？它们是相互排斥的吗？ Doxygen有一个Maven插件吗？ 解决方案 Doxygen具有JavaDoc不提供的许多功能，例如层次结构和合作背景的类图，更多的摘要页面，可选的源代码浏览（与文档交叉链接），在单独的页面上添加诸如@todo的
..