0
点赞
收藏
分享

微信扫一扫

如何为Dash/Zeal生成c++ 文档: 以abseil文档为例

一天清晨 2022-02-23 阅读 37


目录

  1. 软件安装 

  2 Sample源文件下载:

  3. 生成步骤

     3.1 使用doxygen生成html文件

     3.2 使用docsetutil 生成 dash/Zeal 格式


1. 软件安装:   

1.  brew install doxygen
2. brew install swiftdocorg/formulae/docsetutil


2.Sample源文件下载:


git clone https://github.com/abseil/abseil-cpp.git


3. 生成步骤

  3.1 使用doxygen生成html文件


cd ~/icode/abseil-cpp

#生成Doxfile文件
doxygen -g

#修改DoxFile文件
#如果生成Dash/Zeal需要的文档需要更改Doxyfile以下文件
PROJECT_NAME = "Abseil" #项目名称改为Abseil
PROJECT_LOGO = ./absl_80px.png #项目logo
OUTPUT_DIRECTORY = ./absl #项目目录
PROJECT_NUMBER = 1.0.0 #设置版本号
RECURSIVE = YES #递归地搜索所有的子目录及源文件
SOURCE_BROWSER = YES #生成的文档中,把所有的源代码包含在其中
GENERATE TREEVIEW = ALL #添加一个侧边栏,并以树状结构显示包、类、接口等的关系
EXTRACT_ALL = YES 各个类或函数没有文档,也要提取信息。必须把这个标记设置为 Yes。
#创建docset
GENERATE_DOCSET = YES
DISABLE_INDEX = YES
SEARCHENGINE = NO
GENERATE_TREEVIEW = NO

#note 如果遇到这种错误: epstopdf. Check your TeX installation
将 GENERATE_LATEX = NO #latex格式禁掉

#生成html
doxygen ./Doxyfile


   3.2 使用docsetutil 生成 dash/Zeal 格式


cd ~/icode/abseil-cpp/html
make
#note 如果在make的时候遇到 make: /usr/bin/docsetutil:命令未找到
将Makefile文件中的: 第21行改为 docsetutil index $(DOCSET_NAME)即可


  最后使用:使用dash加载即可.

如何为Dash/Zeal生成c++ 文档: 以abseil文档为例_软件安装










编程是一种快乐,享受代码带给我的乐趣!!!


举报

相关推荐

0 条评论