zoukankan      html  css  js  c++  java
  • 使用Xcode生成API文档---03Doxygen详细

    doxygen支持源码编译安装与dmg安装。去doxygen官网下载最新的dmg,doxygen有图形界面,可通过Launchpad打开。
     
    在step 1中选择好项目的路径。
     
    step 2默认是Wizard->Project页面,在其中
     
    1) 在“Project name”中填写项目名。
     
    2) 勾选“Sacn recursively”,扫描所有的子文件夹。
     
    3) 在“Destination directory”中填写好文档的输出目录。这里我填的是“docs”。
    Tips: 输出路径不能包含中文
    点击中间的“Expert”切换Expert->Project页面,在其中
     
    1) 将“OUTPUT_LANGUAGE”设为“Chinese”,使用简体中文。
     
    2) 勾选“JAVADOC_AUTOBRIEF”,自动将注释的第1段识别为简要描述。
     
    点击中间的“Run”切换Run页面,然后点击“Run doxygen”按钮生成文档。
    当文档生成完毕后,使用浏览器打开docs/html/index.html——
    生成PDF
     
    doxygen默认会为生成pdf做好准备。切换到Wizard->Project,会发现它自动勾选了“LaTex”与“as intermediate format for hyperlinked PDF”。
     
    doxygen本身并不能直接输出pdf文件,而是生成了latex目录,其中有一个 makefile 文件。若系统中装好了pdflatex,可在latex目录中运行“make”命令来生成pdf文件。
     
    怎样才能装好pdflatex呢?
    mac平台可安装MacTeX。打开 http://www.tug.org/mactex/ ,下载  MacTeX.pkg (约2.1GB)。MacTeX.pkg下载好后,可双击运行,根据向导来安装。
     
    环境装好之后,当在latex目录中运行“make”命令来生成pdf文件时,你会发现——纯英文文档能顺利生成pdf;而含有中文时,不能顺利生成pdf文件。
     
    对于latex排版,doxygen其实已经做了很多准备,比如——源文件是UTF-8编码,并默认使用了utf8 package。理论上是支持多国语言的。
     
    可对于中文来说,还需要加载 CJKutf8 package,并配置好CJK环境。这才能顺利的使用中文。
     
    用文本编辑器打开docxygen生成的latex目录中的refman.tex。找到“egin{document}”这一行,将其修改为
     
    usepackage{CJKutf8}
    egin{document}
    egin{CJK}{UTF8}{gbsn}
    然后再找到“end{document}”这一行,将其修改为
     
    end{CJK}
    end{document}
    保存并关闭refman.tex。
     
    然后打开终端,使用cd命令进入latex目录,然后执行“make”命令。
    执行完毕后后,该目录中会出现“refman.pdf”——
     

  • 相关阅读:
    webpack打包的项目,如何向项目中注入一个全局变量
    移动端微信H5兼容ios的自动播放音视频
    移动端H5解决键盘弹出时之后滚动位置发生变化的问题
    微信网页开发,如何在H5页面中设置分享的标题,内容以及缩略图
    React实现组件缓存的一种思路
    React编写一个移动H5的纵向翻屏组件
    如何手写一个react项目生成工具,并发布到npm官网
    Puppeteer爬取单页面网站的数据示例
    modelsim中objects窗口为空的解决办法
    Lattice Diamond与modelsim联合仿真环境设置
  • 原文地址:https://www.cnblogs.com/1-434/p/8086435.html
Copyright © 2011-2022 走看看