安装doxygen(一个自动文档生成工具)

由于你电脑里可能还没有doxygen,我们先来安装一下:

sudo apt-get install doxygen doxygen-gui
[sudo] password for wj:
Reading package lists... Done
Building dependency tree
Reading state information... Done
The following package was automatically installed and is no longer required:
  libopencc1
Use ‘apt-get autoremove‘ to remove it.
Suggested packages:
  doxygen-doc
The following NEW packages will be installed:
  doxygen-gui
0 upgraded, 1 newly installed, 0 to remove and 354 not upgraded.
Need to get 279 kB of archives.
After this operation, 671 kB of additional disk space will be used.
Get:1 http://cn.archive.ubuntu.com/ubuntu/ trusty/universe doxygen-gui amd64 1.8.6-2 [279 kB]
Fetched 279 kB in 0s (291 kB/s)
Selecting previously unselected package doxygen-gui.
(Reading database ... 264559 files and directories currently installed.)
Preparing to unpack .../doxygen-gui_1.8.6-2_amd64.deb ...
Unpacking doxygen-gui (1.8.6-2) ...
Processing triggers for man-db (2.6.7.1-1ubuntu1) ...
Setting up doxygen-gui (1.8.6-2) ...

总之,主要是doxygen本体和它的gui模块。如果你不确定,请用这个查一下。

apt-cache search doxygen-gui

拿以难读著称的lsd-slam举个例子。

[1]首先,建个文件夹,把lsd-slam的代码拷下来:

git clone https://github.com/tum-vision/lsd_slam.git

[2]在该文件夹下开一个doc文件夹,把一会儿生成的文档放里头:

mkdir doc;
 cd doc

[3]输入doxywizard调出gui面板。

[email protected]:~/Downloads/lsd_slam/doc$ doxywizard

然后就会出一个面板啦...

我填写的: 1.[1]Step 1中的目录设到你要保存文档的目录。

[2]Project name那些东西随意,可以不设。

[3]重要的是源代码目录source code directory,请把它设到lsd_slam_core/src下,并钩上Scan recursively,表明我们要扫描子文件夹。

[4]输出文件夹设成当前目录./即可,也就是/home/wj/Downloads/lsd_slam/doc

2.进入下一个版块,点左边的“Mode”。下个版块里会让你选语言,既然咱们用c++,保持默认的就可以了。

3.Output和Diagrams也没什么好动的。

4.准备工作完成啦!切到Run,点“Run doxygen",等文档生成完。然后点“show html output",就可以在浏览器里看到文档啦。如果你下一次想直接看,直接打开doc/html/index.html就可以了!

{详细的可以参考:http://www.cnblogs.com/chenyang920/p/5732643.html}

看这个比看源代码效果更高哦!

命令行

  doxygen本身是命令行格式的,给一个配置文件,然后根据配置文件去生成文档。但是!几百个配置选项我怎么记得住啊!既然图形界面那么好用为啥要去用命令行啊!如果没有桌面环境?那还是乖乖用命令行吧……

  命令行的doxygen也很简单。首先用

1 doxygen -s -g settings.txt

  生成一个配置文件,然后去修改配置文件里的值,基本上和上面讲的差不多啦!只是配置会复杂一点。比较重要的参数有输入,输出,扫描文件的后缀名等等。其实这些都可以在图形界面的“Expert“里配的!我也是这么干的!所以如果你有屏幕的话还是建议你用图形界面啦!当这个文件改好后,调用

doxygen settings.txt

  按这个文件生成文档。当然如果你写错了,文档就不会生成了!所以还是用图形界面吧!

时间: 2024-08-29 10:02:43

安装doxygen(一个自动文档生成工具)的相关文章

NetScaler/MAS/XAXD自动文档生成工具

当工程实施后,为用户提交文档一直是工程师比较繁重的工作.这组NetScaler和MAS脚本可以帮助我们自动生成文档减轻部分工作. 脚本基于powershell,利用NetScaler的Nitro RESTful API把所有的信息取出,直接生成word或者pdf版本的文档. 原脚本支持除中文外的多种欧美语言,经过我和作者CarlWebster多次的测试,NetScaler脚本终于支持了中文版的office,可以在中文的系统上直接导出文档了.可在本文下方下载附件. 同时我把NetScaler的脚本

(转)Doxygen文档生成工具

http://blog.csdn.net/lostaway/article/details/6446786 Doxygen 是一个支持 C/C++,以及其它多种语言的跨平台文档生成工具.如同 JavaDoc, doxygen 直接从源文件中提取符合 doxygen 注释规范的注释,生成文档[1]. 1.安装 1.1 安装 Doxygen 1.7.4(Windows) 地址:ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin

文档生成工具doxygen+图像生成工具GraphViz

文档生成工具doxygen+图像生成工具GraphViz 虽然jdk自带的javadoc也很好用,不过使用doxygen+GraphViz 的组合可以生成许多强大的图(类图.协作图.文件包含/被包含图.函数调用/被调用图.类继承体系图等),另外,doxygen支持直接生成chm文档,支持LaTeX公式,如果你有一个支持php的服务器,生成的html还可以加入一个搜索框. doxygen是开源的C语言软体,可以在它的官方网站上下载到软体和源码:http://www.stack.nl/~dimitr

使用Objective-C的文档生成工具:appledoc

前言 做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.今天抽空调研了一下 objective-c 语言的类似工具. 从 stackoverflow 上找到三个比较 popular 的工具:doxygen, headdoc 和 appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/

使用Objective-C的文档生成工具

前言 做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象Java语言本身就自带javadoc命令,可以从源码中抽取文档.今天抽空调研了一下objective-c语言的类似工具. 从stackoverflow 上找到三个比较popular的工具:doxygen, headdoc和appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/doxygen/ind

.NET平台开源项目速览(4).NET文档生成工具ADB及使用

转载自  http://www.cnblogs.com/asxinyu/p/dotnet_Opensource_project_ADB_CSharpDocument.html 阅读目录 1.ADB介绍 2.ADB生成.NET文档过程 3.资源与代码 很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习一些开源项目的过程中,官方没有提供CHM帮助文档,所以为了快速的了解项目结构和注释.就生成文档来自己看,非常好用.这也是一个学习方法吧.例如本文在: .NET平台开源项目速览(2)Co

Markdown 文档生成工具

之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协作工具 docsify:一个神奇的文档站点生成器,简单轻巧,无需静态构建html 教程版: http://me.52fhy.com/learn-markdown-generate-tool/#/ loppo 官网: https://github.com/ruanyf/loppo 依赖 node.js

DBImport v3.3 中文版发布:数据库数据互导及文档生成工具(IT人员必备)

前言: 好久没写文了, 距离上一篇文章是3个月前的事了,虽然工作很忙,主要还是缺少写作的内容和激情,所以没怎么动手. 之前有一个来月不断面试不同层次来应聘的人员,很有想写文的冲动,后来还是忍住了. 估计写了也是那种说人坏话.恨铁不成钢的情绪文,没啥营养,所以情绪过了就没想写了. 在公司除了管理上的事情之外,另外也研发了一套适用信息系统的快速开发框架,这个有机会再写写文和大伙分享了. 下面言归正文了. 背景: 关于这个DBImport工具,发布的版本不多,仅有:V1.0.V2.0.V3.0.V3.

【C#附源码】数据库文档生成工具支持(Excel+Html)

[2015] 很多时候,我们在生成数据库文档时,使用某些工具,可效果总不理想,不是内容不详细,就是表现效果一般般.很多还是word.html的.看着真是别扭.本人习惯用Excel,所以闲暇时,就简单的编写了数据库文档生成工具,供大家交流学习之用,与程序员共勉.     该工具为C#控制台,以NPOI为基础,操作Excel.简单方便,简单配置.两次回车,OK!即可生成清晰的数据库文档.另外,支持生成HTML文档.源码大小7MB,OS上传不了,放到百度云盘里了:http://pan.baidu.co