Doxygen是一种开源跨平台的,类似JavaDoc风格描述的文档系统,支持C.C++.Java.Objective-C等语言.可以从一套归档源文件开始,生成HTML,XML,pdf等不同风格的格式. 按照约定的格式注释源代码,用工具处理注释过的源代码产生文档,通过这种方式产生文档,有以下几个好处. 1. 便于代码和文档保持同步 2. 可以对文档做版本管理 使用方法 要使用Doxygen生成文档,主要有两件事 1. 一般用Doxywizard生成Doxyfile后,再手工修改或者通过向导进行修改…

Doxygen是一种开源跨平台的工具,其功能是从程序源代码中抽取类.方法.成员的注释,形成一个和源代码配套的API(Application Programming Interface,应用程序编程接口)帮助文档.Doxygen工具,以类似JavaDoc风格描述的文档系统,完全支持C.C++.Java.Objective-C等语言,部分支持PHP.C#.注释的语法与Qt-Doc.KDoc和JavaDoc兼容.Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器(或.chm格式),或…

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

参考文章: http://www.fmddlmyy.cn/text21.html http://www.cnblogs.com/duguguiyu/archive/2008/06/29/1231852.html  ---入门介绍 https://www.ibm.com/developerworks/cn/aix/library/au-aix-graphviz/index.html 1 Doxygen简介 1.1 What to do? 使用Doxygen生成文档,主要是两件事: 写一个配置文件(…

参考: 1.https://blog.csdn.net/liao20081228/article/details/77322584 2.https://blog.csdn.net/wang15061955806/article/details/50978195  (有详细格式)   版权声明:本文章转载自Jhuster的<Doxygen详细介绍>.未经作者允许,严禁用于商业出版,否则追究法律责任.网络转载请注明出处,这是对原创者的起码的尊重!!! 1 简介   为代码写注释一直是大多数程序员有…

概述 使用OpenCV的过程中经常查看文档,每次都去官网查看,不过国内访问速度很慢,有一份本地的文档就好了.本文列出了在Linux(Fedora)系统上从OpenCV源码编译出documentation的步骤.在Windows系统上也可以编译出文档,只需在cmake-gui界面中勾选build-doc并根据提示信息安装相应依赖程序,generate后用visual studio编译安装文档. 你也可以直接下载我编译生成好的文档: OpenCV-3.0.0文档:百度云盘 我的github项目. O…

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…

在一个应用的整个开发过程中涉及到了无数的步骤.其中一些是应用的说明,图片的创作,应用的实现,和实现过后的测试阶段.写代码可能组成了这个过程的绝大部分,因为正是它给了应用生命,但是这样还不够,与它同等重要的还有代码的注释和文档编写.不管代码写的有多好,如果缺少了对应的好的注释文档,很有可能在将来带来麻烦.不幸的是,许多开发者都忽视或忽略了代码文档的重要性,而这非常糟糕,因为好的程序不仅仅是好的代码.它需要更多的东西. 谈到编写注释文档,显然我不是说仅仅简单的在实现文档里添加几行注释.肯定是更多的东…

Bullet 全称 Bullet Physics Library,是著名的开源物理引擎(可用于碰撞检测.刚体模拟.可变形体模拟),这里将bullet的学习资源整理一下,希望能帮助入门者少走弯路. 看下wikipedia的介绍还是必要的: http://en.wikipedia.org/wiki/Bullet_(software) 看完才知道,好多大片都用的Bullet做物理模拟,如电影<2012>,这应该能增加你对Bullet的兴趣吧. 官方网站: http://bulletphysics.o…

一． 什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件.通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦.大部分有用的批注都是属于针对函式,类别等等的说明.所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担.不过,反过来说,整理文件的工作对于您来说,就是沉重的负担. Doxygen 就是在您写批注时,稍微…

http://www.stack.nl/~dimitri/doxygen/index.html 非常的方便. 2步生成API文档. 具体信息见官网哟!…

你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码 然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的办法呢?比如根据代码注释自动生成详尽的说明文档……可能有人会说用Javadoc就是 了,要是C/C++.Python.C#等语言写的软件呢?有没有类似Javadoc的东西? Yes,当然有,Doxygen就是这样一个能满足你需求的工具.Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的…

一． 什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件.通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁达尼号同样的辛苦.大部分有用的批注都是属于针对函式,类别等等的说明.所以,如果能依据程序本身的结构,将批注经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担.不过,反过来说,整理文件的工作对于您来说,就是沉重的负担.Doxygen 就是在您写批注时,稍微按…

作者:zyl910 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具.对于Objective-C来说,目前最好用的工具是appledoc和doxygen.可是这两种工具对于注释的要求略有区别.于是我经过一番摸索,找到了一套能同时兼容这两种工具的注释写法. 工具简介——appledoc:简单方便,适于生成apple风格的html文档,及直接集成到xcode帮助(docset).官网 http://gentlebytes.com/appledoc/ .doxygen:功能强大,适…

Chapter 1 - 准备工作 (Windows环境) 1.1 程序包下载 1. Doxygen * 源码: git clone https://github.com/doxygen/doxygen.git * GUI版本:点击下载 * 便携压缩包版本:下载 32位版本 64位版本 2. HTML Help Workshop 用于生成CHM文件,便于传播和查看. Htmlhelp.ex 3. Graphviz 用于绘制DOT语言标本描述的图形.Doxygen 使用 graphviz 自动生成类…

一.doxygen应用场景: doxygen可以用来管理目前主流的编程语言的注释而形成文档系统.(包括C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran等).doxygen官网地址(http://www.doxygen.nl/)近来大部分时间花在api接口的维护上面,其中比较重要的一个环节就是你写的接口如何让调用者一目了然的理解用法.不管是内部无线服务端与客户端之间的配合,还是对外开放的API接口,都一样.花了几…

目录 用doxygen风格注释代码生成文档 1. 说明 2. 具体操作 2.1 生成头部注释 2.2 安装doxygen 2.3 工程配置 3. 总结 用doxygen风格注释代码生成文档 1. 说明 目前由代码生成文档的方式将使项目变得简单,同时生成的文档也会将与代码同步起来.要注意文档的规范性,所以可以采用doxygen自动生成文档.下面通过操作对文档的注释进行一下总结. 2. 具体操作 因为我们用的vscode的,可以下载Doxygen Documentation Generator插件.…

原因不在于doxygen,它没有问题,问题出在微软的HTML Help Workshop的hhc.exe不支持utf8.所以要解决这个问题,需要做两个额外的步骤: 1.将html/index.hhp中的Language=0x409 English (United States)换成Language=0x804 中文 (中国),并将文本存成UTF8格式. 2.将html/index.hhc整个文件从UTF8编码换成gb2312,再次手动调用hhc.exe去处理这个hhp文件即可生成不是乱码的中文c…

类似这样的注释(目前还没用到,先写一个笔记在这,免得忘了) 就像java的注释生成html文档一样…

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

为了将Qt Assistant定制为自己应用程序的帮助文档浏览器.需要完成以下几步: 一.导入HTML格式的帮助文档 (1)首先,针对自己的应用程序创建HTML格式的帮助文档,请参见<Doxygen生成HTML文件>.(下面示例假设HTML文件已经存在) (2)新建Gui应用.QtCreator-->new Project-->Qt Widgets Application 新建项目名称定义为“MyHelpThis”,类名定义为“MainWindow”,基类保持QMainWindow…

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

Web API文档工具列表Swagger ——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例.支持Scala.Java.Javascript.Ruby.PHP甚至 Actionscript 3.在线 Demo .I/O Docs ——I/O Docs是一个用于RESTful Web APIs的交互式文档系统.使用 JSON 模型根据资源.方法和参数定义 APIs.I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统.服务器端基于 Node…

Qt的助手挺好用的. 比chm好多了 cocos2d-x使用doxygen生成文档. 默认生成的是html形式, 需要打开浏览器, 这个是比较耗资源吧 可以修改配置, 让doxygen同时输出qch形式的帮助文档 打开 \cocos2d-x-3.0alpha1\docs\doxygen.config 修改其中几项: GENERATE_QHP = YESQHP_NAMESPACE = "com.cocos2d-x.cocos2d-x-3.0"QHP_VIRTUAL_FOLDER = &q…

原地址:http://blog.csdn.net/u012091672/article/details/17438135 NGUI讨论群:333417608 1.安装Doxygen(http://www.stack.nl/~dimitri/doxygen/) 2.配置 1)工程名 2)版本 3)源代码目录(根据自己的修改) 4)递归扫描(包含子目录) 5)输出目录 1)只输出可以被文档化的实体 2)c#文档优化 1)有导航栏 2)不使用排版 1)随便指定个目录(用来保存配额) 2)切换到运行界面…

利用qt制作帮助文档 1.         创建文档即是一些html文件,这里可以使用qt提供的工具像是qdoc 和Doxygen生成帮助的html文档. 2.         组织文档结构用于qt assistant a)         创建qt help project(.qhp) i.              定义命名空间 命名空间必须是唯一的,除此之外还要设置虚拟文件夹,作为文档集合的通用文件夹.这里每个每个文档集合对应一个命名空间,而这些文档集合的相互共享是通过虚拟文件夹来实现的.…

在使用cocos2d进行游戏开发的过程中,难免要查阅cocos2d的API文档.搞清楚怎么使用某个类或者某个方法.幸运的是,cocos2d的作者已经在源码里面加入了文档凝视,我们仅仅须要使用文档生成工具解析源码生成文档就可以. 最经常使用的文档生成工具是Doxygen. 用Doxygen处理cocos2d文档有2种方式: 第1种方式:安装Doxygen软件,解析cocos2d源码.生成html格式的静态文档 第2种方式:利用cocos2d自带的Doxygen功能,将文档集成到Xcode中 以下我…

其实使用doxygen在Cocos2d-x引擎的doc目录下可以生成离线文档,但是可能每个人为了生成一个离线文档去安装甚至编译doxygen毕竟麻烦,而且现有的doxygen无法生成多语言版本的离线文档.所以为了大家用起Cocos2d-x更方便,在子龙山人的帮助下,我把最新多语言版Cocos2d-x的离线文档给整理出来了. 特点: 1.版本:使用最新的2.x版本和3.x版本. 2.语言:右上角选择C++/JS/Lua即可进行语言切换. 3.跨平台:这里没有使用chm等其他格式,而是直接使用了ht…

MiniGUI各种功能都分布在预先定义宏对每个文档标题.特别不方便查找,这是不利于初学者学习. 有一天,我发现doxygen,因此,使用该工具可以生成一个minigui参考文献 .基于v1.6.10文本. 住址:http://download.csdn.net/detail/u013148209/8137895 演演示样例如以下: 1.搜索函数,可见具有自己主动提示补充功能: 2.搜索结果例如以下: 3.搜索消息: 版权声明:本文博主原创文章.博客,未经同意不得转载.…

phpDocumentor, 分为文档性注释, 和 非文档性注释; 命令为: phpdoc -h, -f, -d.... 提取/ 生成 程序的注释文档, 实际上有很多种工具, 如: doc++, doxygen = dox-y-gen= doxy-generate, ..., 而php的注释文档生成工具是: PhpDocumentor... 安装好pear, phpdoc后,会在/usr/share/中生成pear和pear-data两个目录. 其中pear下是它的核心代码文件,包括inc文件和…