时间:2016年8月21日 天气:中雨转晴:umbrella:->:sunny:
Author:冬之晓:angry:
Email: 347916416@qq.com
MyAppearance:
今天,我在宿舍里又躺了一天,最近宿舍没人,我终于体会到了孤单,突然感觉一个人在外面真的是寂寞, 太让人无所适从了,为了打消无聊只能看程序了……
- @e
使用斜体显示<word>
,用于突出word。
等价于@em
,为了突出多个字可用<em>multiplewords</em>
- @em
使用斜体显示<word>
,用于突出word。
等价于@e
- @endcode
结束一个代码块
也可查看@code
命令
- @enddocbookonly
结束一个@docbookonly
开始的块
- @enddot
结束一个@dot
开始的块
- @endmsc
结束一个@msc
开始的块
- @enduml
结束一个@enduml
开始的块
- @endhtmlonly
结束一个@htmlonly
开始的块
- @endlatexonly
结束一个@latexonly
开始的块
- @endmanonly
结束一个@manonly
开始的块
- @endrtfonly
结束一个@msc
开始的块
- @endverbatim
结束一个@verbatim
开始的块
- @endxmlonly
结束一个@xmlonly
开始的块
- @f$
标记公式文本的开始和结束
- @f[
在单独的一行中显示加长公式的起始标记
- @f]
在单独的一行中显示加长公式的结束标记
- @f{environment}{
在一个指定环境中显示公式的起始标记
- @f}
在一个指定环境中显示公式的结束标记
- @htmlonly [“[block]”]
开始一个文本块,只能被完整包含在生成的HTML文档中。可用@endhtmlonly
命令结束。
此命令可为doxygen包含复杂的HTML代码(如applets,java-scripts,html标记),也可用@latexonly,@endlatexonly
命令提供一份合适的latex文档。
注意:在一个只包含HTML的块中可以解析环境变量(如$(HOME))
- @image
["caption"] [ = ]
在文档中插入一张图片,图片的格式可指定,如果你希望插入多种格式的图片,那么你必须为每种格式设定一次该命令。
第一个参数指定了输出格式,目前只支持html,latex,docbook 和 rtf.
第二个参数指定图片文件名,doxygen将在IMAGE_PATH
标记后指定的路径中查找文件名。如果找到将复制到正确的输出目录中。如果图片文件名中包含空格将使用引号修饰。也可以指定一个URL来替代文件名,那么doxygen将不会复制这个图片,而会检查图片是否存在。
第三个参数可选,用于指定图片中显示的标题。即使它没有包含空格也必须放置到引号之中,在标题显示之前引号会被删除。
第四个参数也可选,用于指定图片的高度和宽度。且只对latex输出有效(即format=latex), sizeindication既可用于图片的宽度也可用于图片的高度,该尺寸可在latex中指定一个有效的尺寸(例如10cm或6英寸或是一个符号宽度@textwidth)。
例如:
/*! Here is a snapshot of my new application:
* \image html application.jpg
* \image latex application.eps "My application" width=10cm
*/
以下是一个可查找的与配置文件关联的例子:
IMAGE_PATH = my_image_dir
警告:HTML中所支持的图片格式受限于浏览器的兼容性。Latex中的图片格式必须是eps(Encapsulated PostScript)。
Doxygen无法检查图片格式是否正确,所以你需要自习确认。
- @latexonly
开始一个文本块,只能被完整包含在生成的latex文档中。可用@endlatexonly
命令结束。
此命令可为doxygen包含复杂的HTML代码(如图片,公式,特殊字符),也可用@htmlonly,@endhtmlonly
命令提供一份合适的latex文档。
注意:在一个只包含latex的块中可以解析环境变量(如$(HOME))
- @manonly
开始一个文本块,只能被完整包含在生成的MAN文档中。可用@endmanonly
命令结束。
此命令可为MAN页面中直接包含groff代码,也可用@htmlonly,@endhtmlonly
命令和@latexonly,@endlatexonly
命令提供一份合适的HTML和latex文档。
- @li { item-description }
除非该命令后遇到一个空白行或是其他@li
命令,此命令都会有一个参数。它可用于生成一个简单的,无嵌套的参数列表。每一个参数都使用一个@li
命令开始。
注意:使用HTML命令可创建嵌套列表
等价于@arg
- @n
加入一条新行,等价于<br>
,可被打印函数使用。
- @p
使用打印字体显示<word>
参数,使用该命令可在运行的文本中引用成员函数。
等价于@c
- @rtfonly
开始一个文本块,只能被完整包含在生成的RTF文档中。可用@endrtfonly
命令结束。
此命令可为doxygen包含复杂的RFT代码。
注意:在一个只包含RFT的块中可以解析环境变量(如$(HOME))
- @verbatim
开始一个能被HTML和latex文档完整包含的文本块,可用@endverbatim
命令结束,在一个完整块中不允许任何注释。
警告:确认每个@verbatim
都对应有一个@endverbatim
,否则解析器将会出现冲突。
- @xmlonly
开始一个能被XML完整包含的文本块,可用@endxmlonly
命令结束。
该命令可用于自定义的XML标记。
- @\
写入一个反斜杠到HTML和latex的输出中,因为doxygen可用此斜杠作为命令之间的分隔符,所以大多数情况下它将被忽略。
- @@
写入一个at符号到HTML和latex的输出中,因为doxygen可用此符号作为JavaDoc命令之间的分隔符,所以大多数情况下它将被忽略。
- @~[LanguageId]
使能/取消一个指定的语言过滤器,用于放置不同语言的文档到一个注释块中,使用OUTPUT_LANGUAGE
标记过滤掉未指定的语言。使用~[LanguageId]可有效一种输出的指定语言,@~则表示在输出中所有语言均有效。(这也是默认设置的),例子:
/*! \~english This is English \~dutch Dit is Nederlands \~german Dies ist
Deutsch. \~ output for all languages.
*/
- @&
写入一个&符号到输出中,因为此符号在HTML中有特殊函数,所以大多数情况下它将被忽略。
- @$
写入一个$符号到输出中,因为此符号可用于扩展环境变量,所以大多数情况下它将被忽略。
- @#
写入一个#符号到输出中,因为此符号可用于引用文档化的主体,所以大多数情况下它将被忽略。
- @<
写入一个<符号到输出中,因为此符号在HTML中有特殊函数,所以大多数情况下它将被忽略。
- @>
写入一个>符号到输出中,因为此符号在HTML中有特殊函数,所以大多数情况下它将被忽略。
- @%
写入一个%符号到输出中,因为此符号可防止自动连接到一个文档化或结构中,所以大多数情况下它将被忽略。
- @”
写入一个”符号到输出中,因为此符号可用于指示一个无格式的文本段,所以大多数情况下它将被忽略。
- @.
这个命令在输出中写一个点号(.)。这个在一下两种情况下比较有用:1.可以当JAVADOC_AUTOBRIEF
设置为可使用的时候防止结束一个简短的描述。2. 可以防止开始一个数列当有一个点号要跟在一个数字后面时。
- @::
这个命令在输出中写一个双冒号(::)。
-
@
这个命令在输出中写一个管道号( | )。这个符号在某些情况下要被避开,因为它也被用于Markdown表格。 |
- @–
这个命令写了两个破折号(–)。这允许连续两个破折号写入输出而不是一个n-dash字符(-)。
- @—
这个命令写三个破折号(—)输出。这允许写三个连续的破折号输出而不是一个m-dash字符(-)。