用doxygen自动生成文档

2024-04-23 00:44:29

1. 添加符合doxygen解析规则的注释

（比如函数说明，函数参数/返回值说明）

用qt-creator可以在函数上方一行键入“/**”，然后直接回车，就可以自动生成默认的格式。

2. 安装doxygen, dot, graphviz

doxygen可以生成html/pdf/rtf，其中rtf效果很差，最好是生成html和pdf。

如果需要生成pdf，则还需要安装texlive-latex-base, texlive-latex-extra

3. doxygen配置文件

doxygen配置文件中的常用选项：

LATEX_HEADER: pdf模板

PROJECT_NAME

PROJECT_NUMBER

PROJECT_BRIEF

PROJECT_LOGO

OUTPUT_DIRECTORY

INPUT：指定源代码或源代码目录

GENERATE_HTML: 默认输出html，不需要可关闭

GENERATE_LATEX: 默认不输出pdf。

4. 生成文档

doxygen <configfile>

pdf文档生成在latex目录下：refman.tex。

需要进行转换：直接在该目录下make就可以。

或者连续运行：pdflatex refman; makeindex refman.idx; pdflatex refman

如果只运行一遍pdflatex，则生成的pdf中不会含有目录信息(outline)。

转载于:https://www.cnblogs.com/realplay/p/9956513.html

用doxygen自动生成文档相关推荐

linux c/c++ 代码使用 doxygen 自动生成文档
www.doxygen.org 的使用非常方便,下面分成2步介绍一下 1. 注释风格,需要在c/c++代码中按照下面的风格添加注释,基本上还是很顺手的 C++的注释风格主要使用下面这种样式:即在注释 ...
Objective-C自动生成文档工具:appledoc
作者 iOS_小松哥关注 2016.12.13 15:47* 字数 919 阅读 727评论 10喜欢 35 由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective-C自动生成文 ...
Objective-C 自动生成文档工具:appledoc
来源:iOS_小松哥 www.jianshu.com/p/fd4d8d6b6177 如有好文章投稿,请点击 → 这里了解详情由于最近琐事比较多,所以好久没有写文章了.今天我们聊一聊Objective ...
MQL5 代码自动生成文档
1. 简介大多数 Java 代码编写者熟悉可通过 JavaDocs 创建的自动生成文档.其思路是以一种半结构化的方式向代码添加注释,然后可以将这些注释提取到易于导航的帮助文件. C++ 世界也有若干 ...
java前端目录_[Java教程]前端那点事儿——Tocify自动生成文档目录
[Java教程]前端那点事儿--Tocify自动生成文档目录 0 2016-06-29 22:00:07 今天偶然间看到文档服务器有一个动态目录功能,点击目录能跳转到指定的位置:窗口滑动也能自动更新目 ...
docwizard c++程序文档自动生成工具_如何开发一个基于 TypeScript 的工具库并自动生成文档
为什么用 TypeScript? TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. Any ...
java动态生成sdk_android、java制作sdk以及自动生成文档
最近一直在做android开发,昨天经理让我写个接口SDK做个接口文档,以便后面的开发. 这让我很焦灼,SDK怎么做?要是只有敲代码还好.可是那个接口文档!!!文档这东西最讨厌了,头都大了后来查了下 ...
java如何写安卓接口文档_android、java制作sdk以及自动生成文档
最近一直在做android开发,昨天经理让我写个接口SDK做个接口文档,以便后面的开发. 这让我很焦灼,SDK怎么做?要是只有敲代码还好.可是那个接口文档!!!文档这东西最讨厌了,头都大了后来查了下 ...
django集成Sphinx，为项目自动生成文档
Sphinx是一个工具,可以轻松创建智能和漂亮的文档,他与Python自带的pydoc是同一类产品,但比pydoc更加优秀,还有很多主题可以选择,平时在开发过程中,我们看到的第三方包的文档,基本上都是 ...

最新文章

热门文章