1. 模块定义(单独显示一页)
/**
* @defgroup 模块名 模块的说明文字
* @{
*/
... 定义的内容 ...
/** @} */ // 模块结尾
/**
* @name 分组说明文字
* @{
*/
... 定义的内容 ...
/** @} */
/**
简要说明文字
*/
#define FLOAT float
/**
@brief 简要说明文字(在前面加 @brief 是标准格式)
*/
#define MIN_UINT 0
/**
* 分行的简要说明
* 这是第二行的简要说明
*/
int b;
/**
* 简要的函数说明文字
* @param [in] param1 参数1说明
* @param [out] param2 参数2说明
* @return 返回值说明
*/
int func(int param1, int param2);
/**
* 打开文件
* 文件打开成功后,必须使用 ::CloseFile 函数关闭。
* @param [in] file_name 文件名字符串
* @param [in] file_mode 文件打开模式字符串,可以由以下几个模块组合而成:
* - r 读取
* - w 可写
* - a 添加
* - t 文本模式(不能与 b 联用)
* - b 二进制模式(不能与 t 联用)
* @return 返回文件编号
* - -1 表示打开文件失败
* @note 文件打开成功后,必须使用 ::CloseFile 函数关闭
* @par 示例:
* @code
// 用文本只读方式打开文件
int f = OpenFile("d:\test.txt", "rt");
* @endcode
* @see ::ReadFile ::WriteFile ::CloseFile
* @deprecated 由于特殊的原因,这个函数可能会在将来的版本中取消。
*/
int OpenFile(const char* file_name, const char* file_mode);
/**
枚举常量
*/
typedef enum TDayOfWeek
{
SUN = 0, /**< 星期天(注意,要以 “<” 小于号开头) */
MON = 1, /**< 星期一 */
TUE = 2, /**< 星期二 */
WED = 3, /**< 星期三 */
THU = 4, /**< 星期四 */
FRI = 5, /**< 星期五 */
SAT = 6 /**< 星期六 */
}
/**
定义类型 TEnumDayOfWeek
*/
TEnumDayOfWeek;
/*
* A list of events:
* - mouse events
* -# mouse move event
* -# mouse click event
* More info about the click event.
* -# mouse double click event
* - keyboard events
* -# key down event
* -# key up event
*
* More text here.
*/
A list of events:
mouse events
mouse move event
mouse click event
More info about the click event.
mouse double click event
keyboard events
key down event
key up event
More text here.
本来来自:http://www.cclove.me/fdaebd0aef2df34428c3ed2eba7d58e8.html