Ubuntu16.04使用Doxygen

  1. 安装Doxygen
    sudo apt-get install doxygen

  2. 安装Graphviz
    sudo apt-get install graphviz

  3. doxygen -g

或者,doxygen –s –g (simple,generate)

使用上述命令在当前目录下生成名为Doxygen的配置文件模板;默认生成的配置文件名为 Doxyfile
1)在配置文件中修改PROJECT_NAME; PROJECT_NUMBER;
OUTPUT_DIRECTORY(输出文档的目录,如果为空,表示在当前目录); OUTPUT_LANGUAGE(可以指定为Chinese);IMAGE_PATH = image_dir(指定图片存放的目录,将图片放到当前目录下的image_dir)
INPUT =xxx,代码文件或目录,多个文件(目录)需要以空格隔开,如果不指定,表示当前目录;如果指定目录且当前目录有代码文件的话,需要用(.)表示当前目录
FILE_PATTERNS = *.cpp *.h
doxygen Doxyfile //可以生成一个文档

  1. c系语言中的注释块
    1)详细注释
    ///
    /// ... text ...
    ///
    或者
    /**
  • ... text ...
    / 等方式。。。
    如果想让注释块更可见,可用下面方式:
    /*********************************//
    *
  • ... text
    *************************************/
    或者
    //////////////////////////////////////////////////////
    /// ... text ...
    /////////////////////////////////////////////////////
    2)简单注释
    /// Brief description.
  1. 文本放在成员后面
    当要给文件的成员,结构体,类,枚举添加文本,需要将文本块放到成员后面。加上<在评论块中,这同样可以作用于函数的参数
    int var; ///< detailed description after the member
    对于函数要使用[in,out]
    void foo(int v /*< [in] docs for input parameter v. /);
    以上4-5只可以用于注释成员(members)和参数(parameters)
    %%%
    变量注释
    /// 简述
    /
    详细描述 */
  2. Doxygen中需要改的地方
    1)DOXYFILE_ENCODING = UTF-8
    2)PROJECT_NAME 项目名称
    3)PROJECT_NUMBER 项目版本号
    4)OUTPUT_DIRECTORY 输出文档的目录,建议写上表示本工程的有意义的目录名称
    5)OUTPUT_LANGUAGE = English,文档语言,可以指定为Chinese
    6)IMAGE_PATH = image_dir,指定图片存放的目录,我们将图片放到当前目录下的image_dir目录中,因为我们的文档会出现测试图片示例
    7)HTML_OUTPUT= . ,html输出目录名称,默认为html目录,如果为“.”则表明为上述OUTPUT_DIRECTORY目录
    8)INPUT =xxx,代码文件或目录,多个文件(目录)需要以空格隔开,如果不指定,表示当前目录,但是,如果指定目录且当前目录有代码文件的话,需要使用点号(“.”)表示当前目录
    9)FILE_PATTERNS=xxx,指定各种文件,我们常用为*.cpp *.c *.h,等等
  3. \class 注释类
    \struct \union \enum \fn注释函数 \var 变量或者类型或者枚举值 \def 注释#define \typedef document a type definition \file 注释一个文件 \namespace 注释命名空间 \package 注释java程序包 \interface 注释一个IDL界面

%%配置选项参考连接
http://blog.51cto.com/ticktick/188672

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,558评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,002评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,024评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,144评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,255评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,295评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,068评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,478评论 1 305
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,789评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,965评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,649评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,267评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,982评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,800评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,847评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,644评论 18 139
  • .bat脚本基本命令语法 目录 批处理的常见命令(未列举的命令还比较多,请查阅帮助信息) 1、REM 和 :: 2...
    庆庆庆庆庆阅读 8,076评论 1 19
  • ¥开启¥ 【iAPP实现进入界面执行逐一显】 〖2017-08-25 15:22:14〗 《//首先开一个线程,因...
    小菜c阅读 6,381评论 0 17
  • php.ini设置,上传大文件: post_max_size = 128Mupload_max_filesize ...
    bycall阅读 6,744评论 3 64
  • 蓝天白云飘,空气清新好。 进山入林去,快活神仙佬。
    退休人老高阅读 105评论 0 0