doxygen_header
/
/// COPYRIGHT NOTICE
/// Copyright (c) 2009, esun .feng
/// All rights reserved.
///
/// @file $FILE$
/// @brief 本文件实现的功能的简述
///
/// 本文件实现的功能的详述
///
/// @version 1.1 版本声明
/// @author 作者!$Author$
/// @date 文件创建日期,eg:$DAY$:$MONTH$:$YEAR$ $HOUR$:$MINUTE$
///
///
/// 修订说明:最初版本
//
doxygen_class
/
/// \class 类名字 类所在文件 "文件路径"
/// \brief 大纲描述.
///
/// 详细描述类的功能
/
doxygen_struct
//
/// \struct $FILE$
/// \brief This is a test struct.
/// Some details about the Test struct
///
doxygen_enum
//
/// \enum TEnum
/// A deion of the enum type.
//
enum TEnum {
Val1, /// \var Enum Val1
Val2 /// Enum Val2
};
doxygen_typedef
//
/// \typedef std::string YString
/// typedef YString.
//
doxygen_macro
//
/// \def MAX(x,y)
/// Computes the maximum of \a x and \a y.
//
doxygen_fuction
/
/// \fn 函数名称
/// \brief 函数功能、性能等的描述.
/// \param[in] 参数
/// \param[out] 参数
/// \exception 异常 std::out_of_range parameter is out of range.
/// \return 返回值
/