Doxygen + graphviz + Windows Help Workshop生成函数调用图和chm文件

工具使用 同时被 2 个专栏收录
1 篇文章 0 订阅
7 篇文章 0 订阅

1. 说明

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。

Graph Visualization Software(Graphviz) 是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形,它也提供了供其他软件使用的函数库.

Windows Help Workshop:使用这个工具可以生成 CHM 格式的文档

2. 下载安装地址

Doxygen下载链接:www.doxygen.org
Graphviz 下载链接:http://www.graphviz.org
HTMLhelp下载链接:http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

3.生成效果

1 下图是用Doxygen+Graphviz从netcat的源代码生成的函数调用关系图。这种图有助于阅读C/C++源代码。
这里写图片描述
2 下面是自己亲测结果
类图:这里写图片描述
Public Member Functions:
这里写图片描述
一个小例子的(为了显示分析的结果)
这里写图片描述
调用图:
这里写图片描述

4. 简单使用生成函数调用图

首先安装doxygen,然后解压下载好的graphviz+HTMLhelp+Windows Help Workshop。
1.下安装Doxygen+Graphviz+Windows Help Workshop。
2. 记住Graphviz和Windows Help Workshop的安装目录,以后要用到。
3. 运行doxywizard。
接着打开doxygen:
第一步:
这里写图片描述
这里写图片描述
第二步:
这里写图片描述

第三步:
这里写图片描述
第四步:
这里写图片描述
这里写图片描述
第五步:
这里写图片描述
第六步:
Build页面,这个页面是生成帮助信息中比较关键的配置页面:

  • EXTRACT_ALL 表示:输出所有的函数,但是private和static函数不属于其管制。
  • EXTRACT_PRIVATE 表示:输出private函数。
  • EXTRACT_STATIC 表示:输出static函数。同时还有几个EXTRACT,相应查看文档即可。
  • SHOW_INCLUDE_FILES 表示:是否显示包含文件,如果开启,帮助中会专门生成一个页面,里面包含所有包含文件的列表。
  • INLINE_INFO :如果开启,那么在帮助文档中,inline函数前面会有一个inline修饰词来标明。
  • SORT_MEMBER_DOCS :如果开启,那么在帮助文档列表显示的时候,函数名称会排序,否则按照解释的顺序显示。

这里写图片描述
第七步:
说明:INPUT_ENCODING (输入的源文件的编码),要与源文件的编码格式相同。如果源文件不是UTF-8编码最好转一下。
这里写图片描述
第八步:在[Expert]的HTML页面中,将HHC_LOCATION指向微软的hhc工具。通常是默认解压缩的文件夹C:/Program Files/HTML Help Workshop/hhc.exe(如果是自己选择的解压缩目录,则选择自己的目录)。
HHC_LOCATION中输入hhc.exe文件的路径。
hhc.exe可以通过安装HTML Help Workshop获得。

CHM_FILE:最终生成的.chm的文件名,如“ProjectHelp.chm”。默认为“index.chm”。可以使用路径,也可以使用相对路径,相对于上面设置的输出目录的html目录(建设使用上一级目录,如“..\MyDoc.chm”)
**HHC_LOCATION:**chm 编译器(hhc.exe)的全路径。请指到 HTML Help Workshop 的安装目录的 hhc.exe 程序
**CHM_INDEX_ENCODING:**chm索引文件编码,下面会讲到,这里填“GBK”
这里写图片描述
如过要像MSDN那样在左边的树中显示函数列表,则在[Expert]的HTML页面,然后选中TOC_EXPAND即可。
这里写图片描述
第九步:
这里写图片描述
这里写图片描述
这里写图片描述
最后一步:
这里写图片描述
最后点击Show HTML output 可以查看文档的有关信息的~
也可以在你当时在第一步时选择的Destination directory:D:\DoxygenWorkspace\dest(看看自己选择的文件夹)那个文件夹里面找到~
如果在CHM_FILE没有选择或者自己填的名称,默认存在Destination directory路径下的html文件夹中可以找到index.chm或者自己命名.chm~
这里写图片描述

整理学习参考于:链接1 链接2 链接3

  • 0
    点赞
  • 0
    评论
  • 9
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

Microsoft Help Workshop——HLP文件轻松做 2002-04-14 11:56作者:陈劲宏出处:Yesky责任编辑:   由于HLP格式已经逐 渐被CHM格式所替代,所以制作HLP格式帮助文档的工具相对来说要少一些。一般有Windows Help Designer/WinHelp Edition、 helppad、Windows帮助大师helper、RTF2HLP我们这里所介绍的Microsoft Help Workshop两种。因为有些工具软件使用时最终还是要Microsoft Help Workshop的支持,我们这里以Microsoft Help Workshop为例介绍一下它的使用方法。 Microsoft Help Workshop(以下简称为HW)是一款专业的制作HLP文件的软件。HW与HTML Help Workshop均是微软开发的制作帮助文件的软件。软件继续保持了简洁、制作方便简单的特点。我们可以到微软的网站去下载,但如果你要下载汉化版的话, 请到http://www.guxiang.com/epubcn/soft-down/hlp/p-helpworkshop403.exe去下载好 了。毕竟汉化版对于英文不太好的朋友来说,还是方便一些。需要说明的是,由于HLP格式出现较早,目前大部分的基于Web的技术都不可以使用。但是由于 HLP文件的界面整洁、对文件的压缩比率较高等特点,目前还广泛应用在很多领域当中。操作步骤为:   1.运行HW以后,单击菜单“文件”|“新建”选项,选择默认的“帮助项目”选项,单击OK(好了)按钮。将工程文件保存在某一目录下并给予文件名。此时弹出主编辑窗口,如1。   2.单击右边的“选项”按钮,在弹出的对话框中我们可以设置文件的属性。包括文件标题、压缩率、排序、各种文件信息、搜索支持、宏定义、字体信息等等。 3.单击“文件”按钮,加入需要编译的RTF文件,注意软件只支持导入RTF文件,如3-2。   4.单击“窗口”按钮,在弹出对话框中设置窗口名称窗口属性。如3-3。   以下的按钮分别是“位(Bitmaps…)”、“映射(Maps…)”、“别名(Alias…)”、“设置(Config…)”、“数据文件(Data Files…)”,如果读者愿意可以一一设置,这里就不详述了。 5.设置好文件信息以后,单击工具栏上的“编译”(Compile)按钮(在?按钮的左边即是),或者单击主编辑窗口右下角的“存盘并编译”(Save and Compile)按钮,此时软件会自动编译输出HLP文件并报告编译信息。 由于HLP文件所支持的格式只能是RTF,所以用户在使用HW之前必须先用WORD制作好RTF文件。 二、制作前的准备   1、下载并安装 HTML Help WorkShop   你可以在微软的站点上下载 HHW 软件,也可以直接 按此下载。   下载 HHW 软件后直接运行 htmlhelp.exe,一路“next”就可以安装成功。HHW 内还含一个形编辑处理程序(HTML Help Image Editor),文件的处理也可以由它简单处理。   2、几个概念   相对来讲制作 chm 文件比较简单,大量的工作实际上是在前期制作 html 文件上,你在 chm 文件中所看到听到的,与你在浏览器中的结果是一样的。你可以专门为制作 chm 文件而编制 HTML,也可以直接利用现成的小型个人主页快速做成 chm 文件以便向外发放,所不同的是,在个人网站上每个 HTML 文件之间必须由超级链接相连,而用来制作 chm 文件的 HTML 文件组里,允许有独立的 HTML 文件,用户可以通过导航嵌窗来实现对其访问。   现在让我们先了解一下几个用到的概念:   (1)项目文件[Project -- .hhp文件]:包含创建 chm 文件所需的 HTML 文件信息、目录表文件信息、索引文件信息、窗口属性、搜索、书签定义等内容。一个chm文件对应有一个项目文件。[设置方法]   (2)目录表文件[Contents -- .hhc文件]:包含目录表中每个标题与 HTML 文件的关联关系。目录表就好像是一本书的目录。该文件不是必需的,如果创建的 chm 文件没有导航嵌窗,就可以不创建 .hhc 文件,这样
©️2021 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值