如何从代码中生成opencv3.0的doxygen文档

时间:2015-07-27 04:55:34

标签: opencv doxygen opencv3.0

我有源代码 opencv3.0 ,我想使用 doxygen 为它生成 HTML文档(我知道在线文档可用,我想自己生成它。但是当我在opencv的主文件夹上运行doxygen时,我什么都没得到(只有一页)。

哪里写了opencv的文档注释?

代码中的文档是单独编写的吗?

2 个答案:

答案 0 :(得分:4)

也许这可以帮到你。我遵循了这条指令,并成功获得了离线文档。

http://docs.opencv.org/master/d4/db1/tutorial_documentation.html#gsc.tab=0

答案 1 :(得分:1)

我遇到了同样的问题,我终于想通了

我们来谈谈Doxygen

Doxygen可以读取代码的注释并生成带有函数的html格式,

如果您想要显示函数调用,doxygen已经为您graphviz组合了

Doxygen GUI - Doxywizard

我更喜欢使用Doxygen GUI(它的名字是doxywizard),因为它更像直观指导性

如果您的操作系统是Ubuntu 16.04,安装很简单:

Sudo apt-get install doxygen-gui

最好的事情是,专家对话中的每一个选择都可以显示其描述(这就是我说有启发性的原因)

万一你不使用你不想要的东西。

Doxywizard文档

个人意见

从我个人的角度来看,OpenCV官方文档列出了所有内容

但是我想要的细节

如某些功能的源代码,例如。 UMat,OpenCL支持的Mat

版本

这有点可怜。