posts - 547, comments - 590, trackbacks - 0, articles - 0

Doxygen生成PDF文档

Posted on 2022-06-06 18:18 eryar 阅读(455) 评论(0)  编辑 收藏 引用 所属分类: 2.OpenCASCADE1.PipeCAD

Doxygen生成PDF文档

eryar@163.com

Key Words. PipeCAD, 三维管道设计软件,三维工厂设计软件,三维配管软件

1 Doxyegn生成 LaTeX

Doxygen是一个强大的文档生成工具,使用Doxygen可以从源码中提取注释自动生成文档,生成的文档可以是html网页,或者CHM,还可以生成LaTeX文件。在OpenCASCADE中,文档的生成就是使用了Doxygen。如doc文件夹中的文件都是自动生成的:

除了overview和refman这种网页文档以外,还生成了pdf文档。生成pdf的文档比网页文档要麻烦一些,需要先生成LaTeX,再结合MiKTeX来生成PDF文档。在dox的resources文件夹中有相应的doxygen配置文件:

通过adm文件夹中的gendoc.tcl可以使用命令参数来方便生成指定的pdf文档。Doxygen的下载地址:https://www.doxygen.nl/download.html

2 MiKTeX生成PDF

使用Doxygen生成LaTeX文件后,需要使用MiKTeX来生成PDF文件。主要是使用occt_pdf_template.tex来配置文档的样式,包括封面等。这些配置都是通过Tcl脚本来实现一些内容的替换。然后调用pdflatex程序来自动生成PDF文件。

在生成的latex文件夹中直接运行make.bat即可生成PDF。

MiKTeX的下载地址:https://miktex.org/download

3 PipeCAD 文档生成

Doxygen不仅能从源码中提取注释,还可以从指定文件中提取相应的内容,现在也支持Markdown格式的文件中提取。学习OpenCASCADE的文档生成经验,使用Markdown结合Doxygen和MiKTeX来生成PipeCAD的用户指南,看上去比较专业。相应的Markdown文件可以放出来大家协同完善。

4下载试用PipeCAD个人版

现在可以直接在Github上下载PipeCAD个人版免费使用:

https://github.com/eryar/PipeCAD/releases

国内用户也可以从如下地址下载PipeCAD个人版免费使用:

https://pan.baidu.com/s/1SwEwp-gHYJqLSb83tVJWtA?pwd=TUVA

PipeCAD自带Sample示例项目,可以通过用户SYSTEM,密码XXXXXX来登录项目体验PipeCAD。关于PipeCAD的使用方法可以到B站查看PipeCAD相关的操作视频:

https://space.bilibili.com/1548012589

欢迎大家下载使用,反馈意见或参与开发,来一起完善PipeCAD。


只有注册用户登录后才能发表评论。
【推荐】超50万行VC++源码: 大型组态工控、电力仿真CAD与GIS源码库
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理