时间:2016年8月20日 天气:晴:sunny:
Author:冬之晓:angry:
Email: 347916416@qq.com
MyAppearance: 
今天，我去申请下来的单人间房子里面看看，发现单人间不仅要钱多，而且还是刚装修好的，里面完全没有打扫，
同时也没有洗衣机，热水器等设备，而且里面一股味道。我非常不满，因此不想住了，但是这边管理房子的人员说不行。
我不住就没人交房租了，我晕。周一只能去找领导问问情况！
今天继续doxygen的命令流程学习
用于视觉增强的命令
- @a
使用一种指定的字体显示<word>参数，在运行的文本使用此命令建立与成员参数的引用。例子：
... the \a x and \a y coordinates are used to ...
一下是显示结果：
… the x and y coordinates are used to …
- @arg { item-description }
除非该命令后遇到一个空白行或是其他@arg命令，此命令都会有一个参数。它可用于生成一个简单的，无嵌套的参数列表。每一个参数都使用一个@arg命令开始。例如：
@arg @c AlignLeft left alignment.
@arg @c AlignCenter center alignment.
@arg @c AlignRight right alignment
No other types of alignment are supported.
结果将显示：
- AlignLeft left alignment.
- AlignCenter center alignment.
- AlignRight right alignment
No other types of alignment are supported.
注意：使用HTML命令可创建嵌套列表。
等价于@li
- @b
使用一个黑体显示<word>参数，等价于<b>word</b>。也可放置多个字，如<b>multiple words</b>。
- @c
使用一个打印字体显示<word>参数，使用该命令引用Word的编码，等价于<tt>word</tt>
例子：
... This function returns @c void and not @c int ...
以下是结果文本：
… This function returns void and not int …
- @code [ ‘{‘
'}']
开始一个代码块，一个代码块的处理不同于普通文本，它默认被解析成C/C++代码，文档化的类和成员的名称将自动被指向文档的连接代替。
- @copydoc
从指定的<link-object>对象中复制一个文档块，并使用本地命令进行解析。为避免文档块重复的情况，该命令将非常有用，或是用于扩展一个派生成员的文档。
连接对象可指向一个成员(可从属一个类，文件或组)，一个类，一个命名空间，一个组，一个页面或是一个文件(按顺序检查)，注意，如果此对象指向一个成员(从属于函数，变量，类型转换等)，为了使其工作，包含它的复合体(类，文件或组)将被文档化。
为了复制类成员的文档，可在文档中放置一下内容：
/*! @copydoc MyClass::myfunction()
* More documentation.
*/
如果该成员被重载，可指定相同的参数类型(与成员名之间不留空格)，如下：
//! @copydoc MyClass::myfunction(type1,type2)
如果在文档块中查到请求该成员的文本，则需要有能匹配的名称。
Copydoc命令可用于递归，但递归的每一层级都会暂时中断并记录，如同出现一个错误。
- @copybrief
@copydoc命令的简易工作方式，只复制简明描述，而不处理细节描述
- @copydetails
@copydoc命令的简易工作方式，只复制简明描述，而不处理细节描述
- @docbookonly
开始一个文本块，这个文本块将仅仅被逐字的包含在生成的docbook文档中。这个文本块以@enddocbookonly命令结束
- @dot [“caption”] [
= ]
开始一个可包含dot图形描述的文本段，此文本段可用@enddot结束。Doxygen传递文本给dot，并在输出的结果图片(一级图片映射)中包含这些文本。图中的节点是可单击的，且能连接URL。可使用URL中的@ref命令方便的连接doxygen中的条目，例如：
/*! class B */
class B {};
/*! class C */
class C {};
/*! @mainpage
* Class relations expressed via an inline dot graph:
* @dot
* digraph example {
* node [shape=record, fontname=Helvetica, fontsize=10];
* b [ label="class B" URL="@ref B"];
* c [ label="class C" URL="@ref C"];
* b -> c [ arrowhead="open", style="dashed" ];
* }
* @enddot
* Note that the classes in the above graph are clickable
* (in the HTML output).
*/
- @msc [“caption”] [
= ]
开始一个可包含消息序列图描述的文本段，查看这个网址的一些例子。此文本段可用命令@endmsc结束。
注意：在msc{…}块中的该文本段只包含消息序列图的一部分。你需要安装mscgen工具，才能使用此命令。例如：
/** Sender class. Can be used to send a command to the server.
* The receiver will acknowledge the command by calling Ack().
* @msc
* Sender,Receiver;
* Sender->Receiver [label="Command()", URL="@ref Receiver::Command()"]; * Sender<-Receiver [label="Ack()", URL="@ref Ack()", ID="1"];
* @endmsc
*/
class Sender
{ public:
/** Acknowledgment from server */
void Ack(bool ok);
};
/** Receiver class. Can be used to receive and execute commands.
* After execution of a command, the receiver will send an acknowledgment
* \msc
* Receiver,Sender;
* Receiver<-Sender [label="Command()", URL="\ref Command()"];
* Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
* \endmsc
*/
class Receiver
{
public:
/** Executable a command on the server */
void Command(int commandId);
};
- @startuml [{file}] [“caption”] [
= ]
开始一个可包含一个PlanUML图的有效描述的文本段，查看这个网址的一些例子。此文本段可用命令@enduml结束。
注意：你需要安装Java和PlantUML’s jar文件才能使用此命令。jar文件的名字要使用PLANTUML_JAR_PATH指明。
第一个参数是可选的并且作为运行doxygen前的一个预处理步骤，为了和运行PlantUML兼容。你也可以在@startuml之后的花括号内增加图像的文件的名字，例如：
@startuml{myimage.png} "Image Caption" width=5cm
Alice -> Bob : Hello
@enduml
当指明图像的名字时，doxygen将会产生一个以那个名字命名的图片。如果没有名字，doxygen将会自动选择一个名字。
第二个参数是可选的并且可以用来指明在图片下面的标题。这个参数必须在两个引号之接指明即使它不包含任何空格。引号在标题显示前会被去掉。
第三个参数同样可选可以用来指明图片的高度和宽度。
下面是一个使用了@startuml命令的例子：
/** Sender class. Can be used to send a command to the server.
* The receiver will acknowledge the command by calling Ack().
* @startuml
* Sender->Receiver : Command()
* Sender<--Receiver : Ack()
* @enduml
*/
class Sender
{
public:
/** Acknowledgment from server */
void Ack(bool ok);
};
/** Receiver class. Can be used to receive and execute commands.
* After execution of a command, the receiver will send an acknowledgment
* @startuml
* Receiver<-Sender : Command()
* Receiver-->Sender : Ack()
* @enduml
*/
class Receiver
{
public:
/** Executable a command on the server */
void Command(int commandId);
};
- @dotfile
["caption"] [ = ]
在文档中插入一副dot生成的<file>图片。
第一个参数指定了图片的名称。Doxygen将会在DOTFILE_DIRS标记后指定的路径中查找文件名。如果找到将作为dot工具的输入文件。结果图片将放置到正确的输入目录中。如果dot文件名中包含空格，需要使用引号进行修饰。
第二个参数可选，用于指定图片中显示的标题，即使它没有包含空格也必须放置到引号之前，在标题显示之前引号会被删除。
- @mscfile
["caption"] [ = ]
在文档中插入一副mscgen生成的<file>图片。查看这个网址的一些例子。
第一个参数指明了图片的文件名。doxygen将会寻找你指明在MSCFILE_DIRS标签后面的路径或文件。如果msc文件被找到，它将被用来作为mscgen工具的输入文件。结果图片将被放到正确的输出目录。如果msc文件名包含空格，你将必须在其周围加上符号(“…”)。
第二个参数是可选的并且可以用来指明在图片下面的标题。这个参数必须在两个引号之接指明即使它不包含任何空格。引号在标题显示前会被去掉。
第三个参数同样可选可以用来指明图片的高度和宽度。
- @diafile
["caption"] [ = ]
在文档中插入一副dia生成的<file>图片。
第一个参数指明了图片的文件名。doxygen将会寻找你指明在DIAFILE_DIRS标签后面的路径或文件。如果msc文件被找到，它将被用来作为mscgen工具的输入文件。结果图片将被放到正确的输出目录。如果msc文件名包含空格，你将必须在其周围加上符号(“…”)。
第二个参数是可选的并且可以用来指明在图片下面的标题。这个参数必须在两个引号之接指明即使它不包含任何空格。引号在标题显示前会被去掉。
第三个参数同样可选可以用来指明图片的高度和宽度。
