开源库中很多帮助文档是html格式,需要通过Doxgen生成 生成后有一系列文件,再通过hhc.exe打包成chm,就能方便拷贝到移动设备查看,比如IOS的chm sharp
下载Doxygen https://www.doxygen.nl/download.html 只需要下载其中的 binaries in a zip,我下载的版本为 doxygen-1.9.3.windows.x64.bin.zip
下载hhc.exe https://docs.microsoft.com/zh-cn/previous-versions/windows/desktop/htmlhelp/microsoft-html-help-downloads 下载其中的 Htmlhelp.exe,下载之后不需要安装,直接用7zip解压到目录,如:D:\Games\htmlhelp\
已开源库RecastNavigation 为例,为其生成html文档,并打包成chm 运行doxygen-1.9.3.windows.x64.bin\doxywizard.exe,菜单:File、Open… 打开recastnavigation\Doxyfile,之后会看到大部分选项都已设置好
这里需要改两处用以生成chm
- Wizard、Output、prepare for compressed HTML (.chm)
- Expert、HTML、设置好chm输出文件名,以及之前解压的hhc.exe路径,建议不要使用相对路径,否则会出错
之后切换到Run标签,点击Run doxygen按钮,就开始生成html,并打包成chm 全部成功之后输出的chm位于 recastnavigation\Docs\html\aaa.chm
|