Ubuntu中利用Doxygen生成开源程序包的API文档

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

在Ubuntu下使用apt-get install命令即可安装doxygen命令行工具和相应的GUI工具,命令如下:

sudo apt-get install doxygen

sudo apt-get install doxygen-gui

操作步骤:

1、以从blfs网站http://www.linuxfromscratch.org/blfs/view/svn/general/dbus.html下载源代码 D-Bus-1.6.10为例,链接为:http://dbus.freedesktop.org/releases/dbus/dbus-1.6.10.tar.gz,这个网站有很多现成的linux常用软件。

2、打开终端,输入doxywizard

3、将刚下载的dbus-1.6.10.tar.gz解压缩

4、配置dbus工程的选项,例如:工程名、版本号和doxygen脚本配置文件存放路径、doxygen API输出文档存放路径等信息。

注意上面的【Scan recursively】单选框一定要选上,否则生成不了对应的doxygen API文档。

5、运行配置脚本,生成doxygen文档。选择run tab页,然后单击Run doxygen

6、直接进入dbus API文档结果输出目录,进入html目录下,即文档输出目录,找到index.html并双击打开,

(引自 http://blog.csdn.net/ccf19881030/article/details/9098041

时间: 2024-10-28 11:21:43

Ubuntu中利用Doxygen生成开源程序包的API文档的相关文章

导出jar包和api文档

导出jar包过程 右击项目名称->export 选择java->JAR file next->选择路径 导出成功 生成api文档 选择doc->右键export java->javadoc 选择项目和路径 途中遇到问题: 错误: 不再支持源选项 1.3.请使用 7 或更高版本. javadoc->next(而不是finish)->next->JRE source compatibility 错误: 编码 GBK 的不可映射字符 javadoc->nex

使用Swagger来生成asp.net core Web API 文档

对于构建一个消费应用程序,理解API的各个方法对开发这是一个不小的挑战.为了使你的API更利于阅读.使用Swagger为你的Web API生成好的文档和帮助页,.NET Core实现了Swashbuckle.AspNetCore,使用Swagger是非常简单的,只需添加一组Nuget包和修改Startup就可以搞定. .Swashbuckle.AspNetCore 开源项目, ASP.NET Core Web API生成Swagger文档的 .Swagger是一个机器可读的restful风格的a

在ubuntu中利用g++编译c++程序

<1> 打开终端,输入命令下载g++ sudo apt-get install g++ <2>编译程序 打开终端,输入g++ 文件名 //进行编译 g++ 文件名 -o 输出文件名 //编译并且指定输出文件名 其余指令可以通过终端中输入 man g++ 查询 <3>>执行程序 输入./*.out即可执行  

浅析如何在Nancy中使用Swagger生成API文档

原文:浅析如何在Nancy中使用Swagger生成API文档 前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document.但是还有许许多多的不足. 为了能稍微完善一下这个Document,这篇引用了当前流行的Swagger,以及另一个开源的Nancy.Swagger项目来完成今天的任务! 注:Swagger是已经相对成熟的了,但Nancy(2.0.0-clinteastwood)和Nancy.Swagger(2.2.6-alpha)是基于目前的最新版本,但目

Eclipse中导入MyEclipse生成的war包

MyEclipse生成的war包中的web根目录是WebRoot,而Eclipse是WebContent,因此,直接导入的话Eclipse是不会认识WebRoot的,需要把Eclipse默认的WebContent改为WebRoot: 1.首先进入项目的文件夹目录,删除.settings目录下的所有文件: 2.然后右击项目,选择Properties,再选择Project Facets: 3.如果第一步没有操作的话,上图中下面的「より詳しい構成が使用可能...」就不会显示.点击「より詳しい構成が使用

Firefox中利用javascript调用本地程序

http://blog.csdn.net/jensonhjt/article/details/1765557 script>function hello () {  netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");  var file = Components.classes["@mozilla.org/file/local;1"].createInstance(

Spring MVC中使用Swagger生成API文档和完整项目示例Demo,swagger-server-api

本文作者:小雷FansUnion-一个有创业和投资经验的资深程序员-全球最大中文IT社区CSDN知名博主-排名第119 实际项目中非常需要写文档,提高Java服务端和Web前端以及移动端的对接效率. 听说Swagger这个工具,还不错,就网上找了些资料,自己实践了下. 一:Swagger介绍 Swagger是当前最好用的Restful API文档生成的开源项目,通过swagger-spring项目 实现了与SpingMVC框架的无缝集成功能,方便生成spring restful风格的接口文档,

ASP.NET Core 3.0 WebApi中使用Swagger生成API文档简介

参考地址,官网:https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio 与https://www.jianshu.com/p/349e130e40d5 当一个WebApi完成之后,书写API文档是一件非常头疼的事,因为不仅要写得清楚,能让调用接口的人看懂,又是非常耗时耗力的一件事.在之前的一篇随笔中(

Spring Boot中使用Swagger2生成RESTful API文档(转)

效果如下图所示: 添加Swagger2依赖 在pom.xml中加入Swagger2的依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <versi