32得票1回答
Sphinx和Doxygen有哪些主要区别?

我想为计算机视觉领域(主要使用C++编写)的一组项目、模块和库准备文档。为此,我查看了 OpenCV 文档,正如您所知,OpenCV 2.4.x 文档基于Sphinx,而这正是我正在寻找的解决方案。Sphinx 的良好功能包括: 在语义层面上具有模块的分层结构。例如,Kalman Filt...

32得票2回答
Doxygen不能文档化静态类?

我最近在使用Doxygen处理我的一个项目。但是,我遇到了一个问题,它不能为C#的静态类生成正确的文档。是否有某个选项需要启用? 相关类的完整源代码在这里。命名空间的Doxygen文件在这里。我的Doxyfile在这里。它是使用几乎默认设置从doxywizard生成的。 如您所见,类的简短...

32得票4回答
使用Doxygen记录C++函数

我有一个项目,我正在使用Doxygen来生成文档。类的文档已经很好了,但我还有一些非成员函数用来创建对象等。我也希望对它们进行文档化,但无论我尝试什么方法,Doxygen都不会从我放在函数上面的注释中生成文档。为什么Doxygen不会为全局命名空间中的函数生成文档,我需要做什么才能让它工作?

31得票5回答
在Eclipse中更改Doxygen注释样式

有人知道如何在Eclipse CDT中编辑Doxygen注释使用的样式吗? 换句话说,在函数前输入/**并按下enter,当前会得到类似以下的内容: /** * * @param one * @param two * @return */ Foo(int one, int tw...

30得票1回答
Doxygen能否轻松配置以识别TODO和FIXME行?

我刚刚安装并设置了Doxygen实例,但默认情况下它只能找到像这样在代码块中标记的TODO标签:/** * @todo Foo */ 它似乎找不到:// TODO Foo // FIXME Bar // @todo Baz 大多数处理解析的IDE和Bug跟踪器都可以很好地处理它们,有没有一...

30得票2回答
Eclipse悬浮提示能显示头文件中的Doxygen注释吗?

我正在使用Eclipse CDT编写C++代码。在StackOverflow上阅读了几篇关于将doxygen文档放置在头文件还是实现文件中的讨论后,大多数开发人员似乎更喜欢将doxygen注释放在头文件中(当然,并非一致)。但是,如果我将doxygen注释放在我的头文件中,当我将鼠标指针悬停在...

29得票1回答
Doxygen @param 方向 参数 [输入],[输出],[输入/输出] 示例输出。

@param 命令的可选 direction 参数在这里被记录为以下之一:here @param[in] @param[out] @param[in,out] 我在任何示例站点中都没有看到这些信息在输出中的呈现方式。是否有关于这些信息应如何出现在输出中的示例?

29得票5回答
在使用C语言的Doxygen时,您是应该注释函数的原型还是定义呢?或者两者都要注释?

我正在使用Doxygen处理一些嵌入式C源代码。对于一个.c/.h文件对,您是将Doxygen的注释放在函数原型(.h文件)上还是放在函数定义(.c文件)上,或者两个位置都重复添加注释? 我遇到了一个问题,即当我只在一个地方记录文档而不在另一个地方时,Doxygen会警告缺少注释; 这是否是...

28得票1回答
Doxygen速度慢

我们的代码库很大,约有150万行,因此Doxygen需要大约12小时才能运行完。但是,它很快就会到达一个我们无法做到每晚更新文档的点,因为花费的时间太长了。为了将其缩短至12小时,我们已经不得不减少图形深度。 我尝试过标准方法,但我确实需要高质量的输出,包括图形和SEARCH_INCLUDE...

28得票2回答
使用Doxygen记录命名空间

我在使用Doxygen时遇到了命名空间和模块识别的问题。我认为问题在于是否将\addtogroup放在命名空间内部还是外部。 示例1,放在命名空间外: /*! * \addtogroup Records * @{ */ //! Generic record interfaces...