标签: doxygen

我正在使用Doxygen和一些嵌入式C源代码.给定一个.c/.h文件对,你是否将Doxygen注释放在函数原型(.h文件)或函数定义(.c文件)上,还是在两个地方都复制它们？

我遇到一个问题,当我在一个地方而不是另一个地方记录时,Doxygen会警告缺少评论; 这是预期的,还是我的Doxygen搞砸了？

我使用doxygen + graphviz来记录我的代码.graphviz在生成图像方面做得很好.

有没有办法更改graphviz的默认fontsize？默认值为14,但我想使用12代替.

更改单个元素(如节点,子图,边缘等)的字体大小真是太痛苦了.

更新:

这里参考的是我在doxygen中使用的代码,(文本字段已经重命名,当然)

@dot
 strict digraph {
   node [shape = box, fontsize = 12];
     subgraph cluster_main {
       fontsize = 12;
       shape    = box;
       label    = "main";
       subgraph cluster_main_common {
         fontsize = 12;
         shape    = box;
         label    = "common";
         subgraph cluster_main_common_source {
           fontsize = 12;
           shape    = box;
           label    = "source"
           subgraph cluster_file1 {
             fontsize = 12;
             shape    = box;
             label    = "file1.c";
             gSystem [label = "var1" URL = "\ref var1"];
           }
           subgraph cluster_file2 {
             fontsize = …

什么选项,以及GUI前端的位置,我是否需要设置删除段落

此类的文档是从以下文件生成的:

从我的项目文档页面？

或者,如何删除此文件列表中的绝对路径,例如C:/Users/Avesta/Desktop/CF/trunnk/CloudServer/在下面的代码段中:

？

如何在Eclipse 3.5中使用eclox？

我正在使用Ubuntu 9.04.我从ubuntu存储库安装了Doxygen(版本1.5.8).然后我通过更新站点在eclipse上安装了eclox.

尽管如此,我没有任何选项可以在任何菜单中启动它.

此外,eclox网站似乎没有任何"入门"指南.

请帮忙.

是否有可能在Doxygen中记录预处理器定义？我希望能够像变量或函数那样做,但Doxygen输出似乎"丢失"了定义的文档,并且也不包含定义本身.

我尝试了以下内容

/**My Preprocessor Macro.*/
#define TEST_DEFINE(x) (x*x)

和

/**@def TEST_DEFINE

   My Preprocessor Macro.
*/
#define TEST_DEFINE(x) (x*x)

我也尝试将它们放在一个组(尝试defgroup,addtogroup和ingroup)中,而不仅仅是在"文件范围",但是也没有效果(尽管组中的其他项目是按照预期记录的).

我查看了各种Doxygen选项,但看不到任何可以启用(或阻止)文档定义的内容.

我目前正在开始使用doxygen来记录我的源代码.我注意到语法非常繁重,每次我修改源代码时,我还需要更改注释,我真的有这样的印象,即在源代码中为每个更改修改注释时要花太多时间.

您是否有一些技巧可以有效地记录我的源代码？

是否存在doxygen执行以下操作的某些编辑器(或现有编辑器的插件)？

• 自动跟踪不同步的代码/注释,并警告程序员.
• 每个新项目的源代码(模板)中自动添加doxygen注释格式(例如,带有参数名称的模板)

PS:我正在开发一个C/C++项目.

我们都有记录代码的好习惯,对吧？

如今,代码内文档本身就有一种语法.它几乎就像一种编程语言.问题是:

• 存在多少(多少)文档语法规范？
• 是否有标准的文档语法？
• 谁在定义这个标准？是否有一个官方委员会或机构(就像有一个定义C++标准)？
• 或者"doxygen"成为事实上的标准？

很难不听说doxygen.在我参与的每个开源软件项目中都提到过.但是,看看官方的doxygen网站,doxygen定义任何规格都是显而易见的! 当我读到"它可以帮助我的方式"时,我得到的印象是,doxygen只是一个提取代码内文档并将其呈现在漂亮的HTML页面中的软件.看看doxygen首页,我甚至认为doxygen可以使用第三方规范中定义的任何文档语法并将其解压缩并输出为HTML.

而且,有趣的是,doxygen的网站,并没有利用这个词doxygen的,就好像它是没有品牌的软件,而是一个普通名词(当然,是吗？)

什么是doxygen真的吗？

• 解析引擎？
• HTML渲染引擎？
• 一个可以被第三方软件用来呈现自己的文档的库？
• 文档语法(事实上)规范？
• 上述所有的？

我对doxygen和其他代码解析器之间的关系特别感到困惑,比如ANTLR,boost-spirit,Ragel ......

例如,什么是doxygen可以做的,ANTLR不能,而ANTLR可以做氧吗？

另外,看看Drupal项目.他们有:

• 他们自己的API模块是" Doxygen文档生成器规范子集的实现 ".
• 他们自己的语法解析器模块(添加到上面的列表,与doxygen本身,ANTLR等等).
• 他们自己的API网站运行上述两个模块,提供Drupal in-code"doxygen"文档.

因此,采用C++类比,似乎"doxygen"这个词过载并且在不同的上下文中意味着不同的东西.

在Drupal项目中,"doxygen"并不是指软件,而是指文档语法的(标准？)规范,尽管如上所述,doxygen网站本身的头版并未声称是这样的事情!

所以,我的离题是:

还有其他文档语法规范吗？

还是刚刚处于'完成'状态？我已经在我的所有PHP项目中使用了PHPDoc多年,但我最近注意到PHPDoc网站上的最后一篇文章是从2008年开始的.所以我想知道是否该时间研究其他替代品如Doxygen.使用PHPDoc以外的东西有什么好处吗？

编辑:今天当Devw宣布发布Zend Framework 1.11.5时,开发区的有趣帖子他写道:

"Mike van Riel提议将我们的API文档生成转换为DocBlox.我们已经考虑将其用于ZF2,但是看到模板系统的灵活性,更重要的是我们在包装方面,速度和最小资源它用于生成输出,我们被出售.(API文档生成时间从80-100分钟减少到不到10分钟.)您可以自己查看结果." http://devzone.zend.com/article/13643

这就是为什么我担心,如果像Zend Framework这样的大型项目正在放弃phpDoc,那么在我看来,phpDoc的不活动不会被忽视.100分钟到10 ..这就是我喜欢听到的.

@ gms8994好打电话

*更新:事实证明DocBlox是伪装/重新品牌的PHPDocumentor2. http://www.docblox-project.org/

Doxygen在我们的代码库上运行大约需要12个小时.这主要是因为要处理的代码很多(~1.5M行).但是,它很快就会达到我们无法进行夜间文档更新的程度,因为它们需要太长时间.我们已经不得不减少图表深度,使其降至12小时.

我已经尝试过标准方法,但我确实需要高质量的输出,这包括图形和SEARCH_INCLUDES.我有一个相当不错的机器来运行Doxygen,但Doxygen没有利用它的许多核心.(它与构建服务器上的单个CPU挂钩,但只占可用系统的4%.)具有多线程Dot构建非常方便,但这只是构建时间的一半左右.

是否有任何技术可用于通过多个进程运行doxygen并手动分割任务？我已经看过一些关于创建标记文件的讨论,但我不太了解他们是否知道他们是否按照我的意愿行事.我正在寻找的是:

doxygen Doxyfile-folder1
doxygen Doxyfile-folder2
doxygen Doxyfile-folder3
doxygen Doxyfile-folder4
doxygen-join output/folder1/html output/folder2/html output/folder3/html output/folder4/html

当然,我只是制作东西,但这是我想要的东西的想法.此外,我使用了超过4个进程.

我刚刚安装并设置了Doxygen实例,但开箱即用它只在代码中找到TODO标签,如下所示:

/**
 * @todo Foo
 */

它似乎没有找到:

// TODO Foo
// FIXME Bar
// @todo Baz

处理解析的大多数IDE和bug跟踪器对它们都很好,有没有一种简单的方法来配置Doxygen来找到它们并将它们列为ToDo项目？