// 项目名称
PROJECT_NAME           = "QJW TEST"
// 项目版本
PROJECT_NUMBER         = "BETA"
// 输出语言（若使用中文，选择Chinese）
OUTPUT_LANGUAGE        = Chinese
// 若是C系语言，选择此项
OPTIMIZE_OUTPUT_FOR_C  = YES
// 若源码是GB编码，使用GB2312，否则保持UTF-8
INPUT_ENCODING         = GB2312
// 不要生成latex
GENERATE_LATEX         = NO
// 需要生成的文件类型
FILE_PATTERNS          = *.c *.cc *.cpp *.c++ *.h

// 生成选项
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_METHODS  = YES
// 将源码一并打包
SOURCE_BROWSER         = YES
// 不要排序
SORT_MEMBER_DOCS       = NO

/**
 * func1 示例
 * @pre 已经初始化
 * @warning 不要传空指针
 * @post 完了可以干坏事了
 * @param [in] a - 参数1
 * @param [out] b - 参数2
 * @param [inout] c - 参数3
 * @return 0 - 成功
 * @return 1 - 如何如何
 * @return -1 - 再如何如何
 */
int func1(int a,int* b,int* c)
{
	return 0;
}

/**
 * @brief func2 示例 \n
 *  fjjfklasdffsd
 * @details fjalsdfad
 * @param [in] a - 参数1
 * @see func1
 * @return 0 - 成功
 */
int func2(int a)
{
	return 0;
}

/**
 * 间接调用func1
 * @code
 *  int main()
 *  {
 *      return 0;
 *  }
 * @endcode
 *
 * @param X - 参数1
 * @param Y - 参数2
 */
#define FUNC(X,Y) \
	func1(111,Y,Z)

/** 简要说明文字 */
#define FLOAT float

/**
 * ##枚举
 * ###枚举1
 * fjafajsdfj
 *
 * ---
 * <http://qjw.qiujinwu.com>
 * @see \n
 *  - func1 \n
 *  - func2
 */
typedef enum
{
	/** enum1 value */
	enum1 = 1,
	enum2 = 2, /**< enum2 value*/
}Enum;


/**
 * 定义个类型2
 * @see Enum
 */
typedef struct 
{
	/** 成员i */
	int i;
	double j; /**< 成员j */
}Cls2;

/**
 * 定义个联合
 * @see Cls2
 */
typedef struct 
{
	/** 成员i */
	int i;
	double j; /**< 成员j */
}union;

/**
 * sth
 */
 
/** sth */

/**
 * @see \n
 *  - func1 \n
 *  - func2
 */

/**
 * 定义个类型2
 * @see Enum
 */
typedef struct 
{
	/** 成员i */
	int i;
	double j; /**< 成员j */
}Cls2;

/** 
 *  A list of events:
 *    - mouse events
 *         + mouse move event
 *         + mouse click event\n
 *            More info about the click event.
 *         + mouse double click event
 *    - keyboard events
 *         1. key down event
 *         2. key up event
 *    - keyboard events
 *         * key down event
 *         * key up event
 *
 *  More text here.
 */

/** @addtogroup group1 grou1 actual name
 * Additional documentation for group 'group1'
 *  @{
 */

/** * func1 */
void func1(){}

/** * func2 */
void func2(){}

/** @}*/

/** @addtogroup group2
 * Additional documentation for group 'group2'
 *  @{
 */

/** * func3 */
void func3(){}

/** * func4 */
void func4(){}

/** @}*/

/** @addtogroup group1 group actual name1
 * Additional documentation for group 'group1'
 */
/** @addtogroup group2 group actual name2
 * Additional documentation for group 'group2'
 */

/** 
 * @ingroup group1
 * func1 
 */
void func1(){}

/** 
 * @ingroup group2
 * func2 
 */
void func2(){}

	/** Function without group. Details. */
	void ungroupedFunction();
	void func1InGroup2();
  protected:
	void func2InGroup2();
};

/** @name Group1
 *  Description of group 1. 
 */
///@{
/** Function 2 in group 2. Details. */
void Test::func1InGroup1() {}
void Test::func2InGroup1() {}
///@}

/** @name Group2
 *  Description of group 2. 
 */
/** @{ */
/** Function 2 in group 2. Details. */
void Test::func2InGroup2() {}
/** Function 1 in group 2. Details. */
void Test::func1InGroup2() {}
/** @} */

/**
@mainpage A simple manual

Some general info.

This manual is divided in the following sections:
- @subpage intro
- @subpage advanced "Advanced usage"
*/

//-----------------------------------------------------------

/** @page intro Introduction
This page introduces the user to the topic.
Now you can proceed to the \ref advanced "advanced section".
*/

//-----------------------------------------------------------

/** @page advanced Advanced Usage
This page is for advanced users.
Make sure you have first read \ref intro "the introduction".
*/

CHM_INDEX_ENCODING     = GBK
HHC_LOCATION           = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
GENERATE_HTMLHELP      = YES

HHC_LOCATION = "/cygdrive/c/Program Files (x86)/HTML Help Workshop/hhc.exe"