doxygen
冬之晓东
国家对地观测科学数据中心信息发布
展开
-
Doxygen使用学习(四)------Doxygen的特殊命令字之"小节指示命令"
小节指示命令都比较常用,要多多学习!@attention { attention text }开始一个可输入需要处理信息的段落,次段落将会缩排,段落的文本不会指定一个内部结构,所有视觉增强的命令可以放置到该段落中,多个相邻的@attention命令将被组合到一个单独的段落中,当遇到一个空白行或者是其他的小节命令,那么@attention将终止。@author { list of authors原创 2016-08-16 12:38:36 · 2101 阅读 · 0 评论 -
Doxygen使用学习(五)------Doxygen的特殊命令字之"创建连接命令"
创建连接命令@addindex (text)添加1文本到latex索引中@anchor 放置一个不可见的已命名的anchor(固定点)到文档中,且能使用@ref命令进行引用。 注意:anchor目前只能放置在一个标记成页面(使用@page)或主页(使用@mainpage)的注释块中@cite 增加一个书籍参考到一个文本和数目参考列表里。@endlink终止一个命令@link开始的连原创 2016-08-16 12:39:26 · 2681 阅读 · 0 评论 -
Doxygen使用学习(六)------Doxygen的特殊命令字之"用于显示例子的命令"
用于显示例子(将被插入文档中的代码)的命令@dontinclude 用于解析一个源文件,且不论是否被文档完整包含(如同@include命令所做的),如果你希望将源文件分割成最小的块,并在这些块中间添加文档,那此命令会非常有用。源文件或是目录可使用配置文件中的EXAMPLE_PATH标记来指定。在解析包含@dotinclude命令的注释块期间,代码段中类和成员的声明和定义将被’记忆’。对于单行可使原创 2016-08-21 22:45:30 · 2080 阅读 · 0 评论 -
Doxygen使用学习(七)------Doxygen的特殊命令字之"用于视觉增强的命令"
今天继续doxygen的命令流程学习,用于视觉增强的命令也很常用,特别是你要在程序的注释中使得一些重点语句使得这些语句显示的更加突出,让阅读的人一目了然。@a 使用一种指定的字体显示<word>参数,在运行的文本使用此命令建立与成员参数的引用。例子:... the \a x and \a y coordinates are used to ...一下是显示结果:… the x and y coo原创 2016-08-24 20:31:33 · 3036 阅读 · 0 评论 -
Doxygen使用学习(一)------Doxygen的简单注释格式
最近,我通过看别人的没有文档代码,终于醒悟了,感觉到了文档的重要性!(看不懂别人代码的痛苦太难受了!) 所以我觉定,趁着周末赶快学习一下如何使用文档生成工具。 通过网上检索,我发现Doxygen是一个很常用的文档生成工具。进入http://www.stack.nl/~dimitri/doxygen/“>Doxygen官网,然后从Downloads标签里面获取Windows版的安装包(当然其他主流操原创 2016-08-12 12:52:21 · 4859 阅读 · 2 评论 -
Doxygen使用学习(二)------Doxygen的内部支持的markdown语法
Doxygen的内部支持的markdown语法段落markdown本身的语法没有段落一说,因此需要分段的地方多空一行,就可以表示段落,例如:(普通的markdown还支持段落尾空两格代表分段,但是Doxygen不支持!)Here is text for one paragraph.We continue with more text in another paragraph.这样出来的效果就分段原创 2016-08-12 12:53:22 · 2128 阅读 · 0 评论 -
Doxygen使用学习(三)------Doxygen的特殊命令字之"结构类的表达"
Doxygen的特殊命令字Doxygen在进行注释的时候,有很多以@或者\开头后面加上一个特殊命令的字段,然后就可以在生成文档的时候有特殊的作用,我一般喜欢用@,所以后面的命令都使用这个标签,下面我来介绍一下。结构类的表达@addtogroup [(title)]使用@defgroup同样可以定义一个组,但是相比之下,多次使用相同<name>的@addtogroup命令并不会出现警告,而它是一原创 2016-08-14 14:59:16 · 5465 阅读 · 0 评论