doxygen使用-快速阅读代码

https://blog.csdn.net/joyjj0218/article/details/48084543

https://www.linuxidc.com/Linux/2015-04/116607.htm

https://www.ibm.com/developerworks/cn/aix/library/au-learningdoxygen/#list12

 

需要修改的配置项如下:

DOXYFILE_ENCODING = UTF-8,默认编码为UTF-8,这样可以支持中文。

PROJECT_NAME = “SerialPort”,项目名称,多个单词需要使用引号(“”)。

PROJECT_NUMBER = “1.0 beta”,项目版本号。

OUTPUT_DIRECTORY = serialport-html,输出文档的目录,如果为空,表示在当前目录,建议写上表示本工程的有意义的目录名称,比如我们就指定目录名称为serialport-html。

OUTPUT_LANGUAGE = English,文档语言,可以指定为Chinese。

IMAGE_PATH = image_dir,指定图片存放的目录,我们将图片放到当前目录下的image_dir目录中,因为我们的文档会出现测试图片示例。

HTML_OUTPUT= . ,html输出目录名称,默认为html目录,如果为“.”则表明为上述OUTPUT_DIRECTORY目录。

GENERATE_LATEX = NO,是否生成LaTeX,默认生成的,但我们不想生成。

好了,我们需要修改的就这么多,使用上述第2步骤的命令就可以生成一个漂亮的文档了。此外还有一些常用的设置选项。

INPUT =xxx,代码文件或目录,多个文件(目录)需要以空格隔开,如果不指定,表示当前目录,但是,如果指定目录且当前目录有代码文件的话,需要使用点号(“.”)表示当前目录。

FILE_PATTERNS=xxx,指定各种文件,我们常用为*.cpp *.c *.h,等等。

 

发布了109 篇原创文章 · 获赞 85 · 访问量 48万+
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客

分享到微信朋友圈

×

扫一扫,手机浏览