• Doxygen中文使用


    Doxygen中文使用

     

    以下对Doxygen的使用分为三个部分:

    一.生成基本的中文注释文档;

    二.添加函数关系调用图;

    三.生成全中文的chm文档。

     

    一.生成基本的中文注释文档:

    参考网站http://www.xjtudll.cn/Exp/243/。生成一个Doxygen注释文档需要进行两大步配置:Wizard、Expert。

    (一)   Wizard

    (1)       Wizard->Project

     

    Project name生成的Doxygen注释文档的名称;

    Project synopsis生成的Doxygen注释文档的简介;

    Project version or id注释文档版本号;

    Project logo文档图标;

    Source code directory代码路径,也就是需要生成注释文档的代码所在的文件夹;

    Destination directory生成的注释文档存放的地方。

     

    (2)       Wizard->Mode

     

    若勾选上Include cross-referenced source code in output,则生成的Doxygen文档会包含相应头文件的源代码。

     

    (3)       Wizard->Output

     

    plain HTML生成平铺形式的页面;

    with navigation panel生成带有左侧导航栏形式的页面;

    prepare for compressed HTML(.chm):准备生成chm文件。

     

    (4)       Wizard->Diagrams

            若不生成函数调用关系图,默认即可。

     

    (二)   Expert

    (1)       Expert->Project

     

    OUTPUT_LANGUAGE一栏中选择输出语言为Chinese。

    (2)       Expert->Input

     

    INPUT_ENCODING一栏中,输入GB2312,这样对文档的注释才支持中文,否则中文注释将会是乱码。

     

    在完成上诉配置后,在Run选项卡中点击Run doxygen,即可生成能够支持中文注释的文档。

     

    二.填加函数关系调用图:

    参考网站:http://www.xjtudll.cn/Exp/245/

    (一)   Expert->Dot

     

    勾选HAVE_DOT、CALL_GRAPH、CALLER_GRAPH选项,并在DOT_PATH中添加graphviz安装目录下的bin文件夹。

     

    (二)   Wizard->Project

             勾选Scan recursively

    (三)   Expert->Build

     

    勾选EXTRACT_ALL、EXTRACT_PRIVATE、EXTRACT_PACKAGE、EXTRACT_STATIC、EXTRACT_LOCAL_METHODS

    (四)   Wizard->Diagrams

    选择Use dot tool from the GraphViz package

     

    三.生成全中文的chm文档

    参考网站:http://www.erchashu.com/wiki/doxygen-chm-chinese-hlep-doc。需要下载工具HTML Help Workshop 1.3

    (一)   Wizard->Output

         勾选prepare for compressed HTML(.chm)

     

    (二)   Expert->HTML

     

    勾选GENERATE_HEMLHELP

    CHM_FILE一栏中,填入生成的.chm文件的文件名;

    HHC_LOCATION一栏中,填入HTML Help Workshop 1.3的安装路径,选择文件hhc.exe;

    CHM_INDEX_ENCODING一栏中填入GBK。

     

    至此,所有配置完成。关于Doxygen能识别的注释风格,可以参考网站:http://ticktick.blog.51cto.com/823160/188674

  • 相关阅读:
    android基础开发之一setContentView用法
    setContentView( )方法
    如何使用andriod的布局标签
    也谈layout_gravity和gravity的用法
    SlidingMenu第二篇 --- SlidingMenu常用属性介绍
    SlidingMenu第一篇 --- 导入SlidingMenu库
    JS----对象的合并与克隆
    angular2 ----字符串、对象、base64 之间的转换
    WebStorm过期解决方法
    JavaScript--鼠标滚动改变图片大小
  • 原文地址:https://www.cnblogs.com/ppffs/p/3203111.html
Copyright © 2020-2023  润新知