pdf

doxygen中文手册,高清

  • 1星
  • 日期: 2018-07-11
  • 大小: 2.23MB
  • 所需积分:1分
  • 下载次数:1
  • favicon收藏
  • rep举报
  • 分享
  • free评论
标签: doxygen

doxygen

注释生成

注释生成

注释生成器,很牛的软件

文档内容节选

中文手册 v163 中文手册 DDDDoxygen oxygen v163 中文手册中文手册 oxygen oxygen v163 v163 Anan Anan AnanAnan 声声声声 明明明明 1 此为免费文档,请勿用于商业用途 2 对于本手册的任何问题,请到各大专业论坛发问,我相信你会得到很多人的帮助 约约约约 定定定定 1 对于意思不明确难以判断的句子,在给出的译文之后紧跟红色标记的原文 to get red origin text after translated text 2 对于省略的部分,即带有略字提示的部分,依旧会给出原文,以保证文档的完整性 3 doxygen 配置文件中的选项标记一律使用蓝色提示 4 文中的内容备注一律使用橙色提示 5 对于文中所有的标题均用黑色粗体黑色粗体黑色粗体黑色粗体表示 6 文中的符号一律使用双引号标注,除去特别加入反斜杠表示转义之外,双引号无意义 7 文中的章节名称一律使用双引号粗体粗体粗体粗体标注,所以与......

中文手册 v1.63 中文手册 DDDDoxygen oxygen v1.63 中文手册中文手册 oxygen oxygen v1.63 v1.63 Anan Anan AnanAnan -------------------------------- 【 声声声声 明明明明 】】】】 ----------------------------------- 1. 此为免费文档,请勿用于商业用途。 2. 对于本手册的任何问题,请到各大专业论坛发问,我相信你会得到很多人的帮助。 -------------------------------- 【 约约约约 定定定定 】】】】 ----------------------------------- 1. 对于意思不明确难以判断的句子,在给出的译文之后紧跟红色标记的原文 to get red origin text after translated text 。 2. 对于省略的部分,即带有(略)字提示的部分,依旧会给出原文,以保证文档的完整性。 3. doxygen 配置文件中的选项标记一律使用蓝色提示。 4. 文中的内容备注一律使用橙色提示。 5. 对于文中所有的标题均用黑色粗体黑色粗体黑色粗体黑色粗体表示。 6. 文中的符号一律使用“”双引号标注,除去特别加入\“\”反斜杠表示转义之外,双引号无意义。 7. 文中的章节名称一律使用“”双引号粗体粗体粗体粗体标注,所以与符号不存在冲突。 8. 原文的错误一律使用绿色提示,并在译文之后给出,错处用下划线标注。 -------------------------------- 【 问题问题问题问题】】】】 ----------------------------------- -------------------------------- 【 正文正文正文正文 】】】】 ----------------------------------- 此手册被分为三个部分,每个部分都包含若干章节。 第一部分是用户指南 1. 安装安装安装安装,讨论如何在你的平台中下载,编译和安装 doxygen。 2. 开始开始开始开始,告诉你如何快速生成第一个 doxygen 文档。 3. 代码文档化 代码文档化,演示代码被文档化的若干方法。 代码文档化 代码文档化 4. 列表列表列表列表,,,,显示创建列表的若干方法。 5. 组合组合组合组合,显示如何将一些工作组合在一起。 6. 包含公式包含公式包含公式包含公式,显示如何在文档中插入公式。 7. 图形和图表 图形和图表,描述 doxygen 生成图表和图形。 图形和图表 图形和图表 8. 预处理预处理预处理预处理,解析 doxygen 如何处理宏定义。 9. 生成自动生成自动生成自动生成自动链链链链接接接接,显示如何在文档中放置文件,类,成员的链接。 10. 输出格式输出格式输出格式输出格式,显示如何生成 doxygen 支持的多种输出格式。 11. 搜索搜索搜索搜索,显示在 HTML 文档中进行搜索的若干方法。 12. 自定义输出 自定义输出,解析如何在 doxygen 中生成自定义的输出。 自定义输出 自定义输出 13. 自定义命令 自定义命令,显示如何在你的注释中定义和使用自定义的命令。 自定义命令 自定义命令 14. 连接到外部文档 连接到外部文档,解析如何让 doxygen 创建与外部已生成文档的链接。 连接到外部文档 连接到外部文档 15. FAQFAQFAQFAQ,对频繁出现的提问给出的回答。 16. 排错排错排错排错,当出现问题时,它会告诉你该做些什么。 第二部分是参考指南 1. 特点特点特点特点,展示 doxygen 的功能概览。 2. doxygen doxygen 历史历史历史历史,告知 doxygen 在开发过程中的变化,以及它一直在进行的内容。 doxygen doxygen 3. doxygen doxygen 用法用法用法用法,告知如何使用 doxygen。 doxygen doxygen 4. doxytag doxytag 用法用法用法用法,告知如何使用 doxytag。 doxytag doxytag 5. doxywizard doxywizard 用法用法用法用法,告知如何使用 doxywizard。 doxywizard doxywizard 6. installdox installdox 用法用法用法用法,告知如果你使用 tag 文件,在 doxygen 中如何使用生成的 installdox 脚本。 installdox installdox 7. 配置配置配置配置,告知如何调整 doxygen,以便生成你需要的文档。 8. 特殊命令字 特殊命令字,告知在文档中能使用的特殊命令的概览。 特殊命令字 特殊命令字 9. HTMLHTMLHTMLHTML 命令字命令字命令字命令字,告知在文档中能使用的 HTML 命令的概览。 10. XMLXMLXMLXML 命令字命令字命令字命令字,告知在文档中能使用的 C#风格的 XML 命令的概览。 第三部分为 doxygen 开发者提供的一些信息(略) 1. doxygen doxygen 内部构造内部构造内部构造内部构造,给出 doxygen 内部结构的整体概览。 doxygen doxygen 2. PerlPerlPerlPerl 模块的输出格式 模块的输出格式,显示如何使用 PerlMod 的输出。 模块的输出格式 模块的输出格式 3. 国际化国际化国际化国际化,解析如何添加新语种的输出支持。 安安安安 装装装装 如果你还没有 doxygen 程序包,首先可以去 http://www.doxygen.org/download.html 页面获得最新的版本。 本章节包含以下几部分: Unix 源码包编译 Unix 二进制包安装 Unix 已知的编译问题 Windows 源码包编译 Windows 二进制包安装 Doxygen 开发工具(略) Unix Unix 源码包源码包源码包源码包编译编译编译编译 Unix Unix 如果你已下载了源码包,你需要按照以下的步骤来创建可执行文件: 1. 需要 GNU 工具软件,flex,bison,GNU make,strip 2. 为了生成 Makefile,你需要安装 Perl。 3. 配置脚本已假定标准的 Unix 工具,例如 sed,date,find,uname,mv,cp,cat,echo,tr,cd,rm 都是 可用的。 想获得 doxygen 的所有功能,以下的辅助工具必须安装。 1. QT 4.3 或者更高版本,用于创建 GUI 后端 doxywizard。 2. 一个 OCR 种类的发布程序,比如 teTex 1.0,用于生成 LaTex,Postscript,PDF 的输出。 3. Graph visualization toolkit 1.8 或者更高版本,doxygen 中的 graphs, graphical inheritance graphs, collaboration graphs 与 graphviz 都存在依赖关系,如果你准备重新编译 graphviz,确认系统是否支持 freetype,否则 graphs 无法渲染特殊文本的标记。 4. 如 果 需 要 显 示 公 式 , 并 且 你 不 想 使 用 pdflatex , 那 么 ghostscript 也 是 必 须 的 , 你 可 以 在 www.ghostscript.com 找到它。 5. 为了生成 doxygen 自身的文档,需要 Python,你可以在 www.python.org 找到它。 执行以下的步骤进行编译: 1. 解压程序包 gunzip doxygen-$VERSION.src.tar.gz # uncompress the archive tar xf doxygen-$VERSION.src.tar # unpack it 2. 运行配置脚本 sh ./configure 此脚本尝试检测你所使用的平台,make(必须是 GNU make),以及 Perl,并且脚本会输出检测结果。 你可以运行以下命令来配置,使用检测出的平台和编译器来替换掉命令中的 platform-type。 configure –platform platform-type 比对一下程序包中 PLATFORMS 文件所列出的平台与命令中的 platform-type。 如果系统中存在 QT 4.3 或者更高的版本,并需要创建 GUI 后端,要运行配置脚本的--with-doxywizard 选项, configure --with-doxywizard 其他的配置选项的概览可以使用, configure --help 3. 运行 make 编译程序 make 如果程序编译无任何问题,在系统的 bin 目录下将会有三个二进制可执行文件,doxygen,doxytag,doxywizard。 4. 生成用户手册 make docs 让 doxygen 生成 HTML 文档,在系统中的 HTML 目录下将包含此文档(目录中的 index.html 文件将指向一个 HTML 浏览器),此时你将需要 python 的支持。 5. 生成一个 PDF 版本的用户手册(此时你需要 pdflatex,makeindex,egrep 的支持) make pdf doxygen_manual.pdf 将放置在系统的 latex 目录下,可以使用 acrobat reader 查看和打印。 6. 安装 doxygen make install Unix 二进制包 Unix 二进制包安装安装安装安装 二进制包二进制包 Unix Unix 如果你下载的是一个 Unix 的二进制发行版本,输入: ./configure Make install 可执行的二进制文件将被安装到/bin 目录下,使用 make install_doc 安装 doxygen 的文档和例子,安 装目录为/doxygen。 默认路径为/usr/local, 可使用配置脚本的--prefix 选项来修改安装的默认路径。 默认路径为/share/doc/packages,可是使用配置脚本的--docdir 选项来修改默认路径。 当然你也可以直接复制 doxygen 二进制文件,到/bin 或者 PATH 变量中能被检索到 bin 目录下,这一点对使用 doxygen 很重要。 注意注意注意注意:::: 你需要 GNU 安装工具来完成上述的工作(这只是所需支持程序包的一部分),而其他的安装支持工具有可能被放 置到错误的目录下,请确认!如果你使用的是一个 RPM 或者 DEP 软件包,请遵照这些安装包的标准安装过程进行。 Unix 已知的编译问题 Unix 已知的编译问题 已知的编译问题 Unix Unix 已知的编译问题 Qt 的问题 一些系统中 Qt 的头文件和库文件不在 QTDIR 所指向的目录下(比如 Red Hat 6.0,头文件路径/usr/include/qt, 库文件路径/usr/lib)。 解决方法: 进入 doxygen 的根目录, mkdir qt cd qt ln -s your-qt-include-dir-here include ln -s your-qt-lib-dir-here lib export QTDIR=$PWD 如果你使用 C 风格的 shell,可用 setenv QTDIR $PWD 来替换 export 那一行。
更多简介内容

推荐帖子

评论

登录/注册

意见反馈

求资源

回顶部

datasheet推荐 换一换

About Us 关于我们 客户服务 联系方式 器件索引 网站地图 最新更新 手机版 版权声明

北京市海淀区知春路23号集成电路设计园量子银座1305 电话:(010)82350740 邮编:100191

电子工程世界版权所有 京ICP证060456号 京ICP备10001474号 电信业务审批[2006]字第258号函 京公海网安备110108001534 Copyright © 2005-2020 EEWORLD.com.cn, Inc. All rights reserved
$(function(){ var appid = $(".select li a").data("channel"); $(".select li a").click(function(){ var appid = $(this).data("channel"); $('.select dt').html($(this).html()); $('#channel').val(appid); }) })