Diff: dialog_fota/app.h

Revision:

9:fcf91f563147

Parent:

8:9eec2c246a85

Child:

12:e3d3676753cc

--- a/dialog_fota/app.h	Thu Aug 20 05:16:55 2015 +0000
+++ b/dialog_fota/app.h	Mon Aug 24 02:29:16 2015 +0000
@@ -1,3 +1,12 @@
+/**
+ * @file app.h
+ * @brief Application entry point
+ * Copyright 2015 SEVENCORE Co., Ltd.
+ *
+ * @author HyeongJun Kim 
+ * @version 1.0.0  
+ * @date 2015-08-17
+*/
 #ifndef APP_H
 #define APP_H
 
@@ -8,7 +17,14 @@
 
 namespace sevencore_fota{
 
-
+/**
+ ****************************************************************************************
+ * @addtogroup dialog_fota module
+ * @brief Application entry point Header.
+ *
+ * @{
+ ****************************************************************************************
+ */
 
 #define KE_IDX_GET(uint16_t) (((uint16_t) >> 8) & 0xFF)
 #define KE_BUILD_ID(type, index) ( (uint16_t)(((index) << 8)|(type)) )
@@ -88,19 +104,88 @@
 
 extern struct app_env_tag app_env;
 
+/**
+ ****************************************************************************************
+ * @brief Send Reset request to GAPM task.
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_rst_gap(BleMsgHandler *BMH);
+/**
+ ****************************************************************************************
+ * @brief Send enable request to DISS profile task.
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_diss_db_create(BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Send enable request to FOTA profile task.
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_fota_server_db_create(BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Send Start Advertising command to GAPM task.
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_adv_start(BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Set Bondabe mode.
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_set_mode(BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Send enable request to DISS profile task.
+ * @param[in] device  Ble device info
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
+void app_dis_enable(ble_dev *device,BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Send enable request to FOTA profile task.
+ * @param[in] device  Ble device info
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_fota_server_enable(ble_dev *device,BleMsgHandler* BMH);
-void app_dis_enable(ble_dev *device,BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Send connection confirmation.
+ * param[in] auth  Authentication requirements.
+ * @param[in] device  Ble device info
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_connect_confirm(uint8_t auth,ble_dev *device,BleMsgHandler* BMH);
+/**
+ ****************************************************************************************
+ * @brief Send the GAPC_DISCONNECT_IND message to a task.
+ * @param[in] dst     Task id of the destination task.
+ * @param[in] conhdl  The conhdl parameter of the GAPC_DISCONNECT_IND message.
+ * @param[in] reason  The reason parameter of the GAPC_DISCONNECT_IND message.
+ * @param[in] BMH     Ble Message Handler class reference
+ * @return void.
+ ****************************************************************************************
+ */
 void app_send_disconnect(uint16_t dst, uint16_t conhdl, uint8_t reason,BleMsgHandler* BMH);
 
-
-
-
 }//namespace
 
+/// @} dialog_fota module
+
 #endif//APP_H