如何为Dash/Zeal生成c++ 文档: 以abseil文档为例
目录
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加载即可.
编程是一种快乐,享受代码带给我的乐趣!!!
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
· C++代码改造为UTF-8编码问题的总结
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· 清华大学推出第四讲使用 DeepSeek + DeepResearch 让科研像聊天一样简单!
· 实操Deepseek接入个人知识库
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
2015-12-14 ijg库的使用的几点注意
2013-12-14 HDUOJ----(2612)Find a way