TizenRefApp-9383 Add doxygen documentation

Change-Id: I82f973f5b0d303a70db0e2257de2d38a9974420e
Signed-off-by: Evgen Servetnik <e.servetnik@samsung.com>

4 files changed, 18 insertions, 12 deletions

diff --git a/inc/log.h b/inc/log.h
index 150ac8f..e3d4e4a 100755
--- a/inc/log.h
+++ b/inc/log.h
@@ -21,6 +21,7 @@
 #include <unistd.h>
 #include <dlog.h>
 
+/* color defines */
 #define FONT_COLOR_RESET    "\033[0m"
 #define FONT_COLOR_RED      "\033[31m"
 #define FONT_COLOR_GREEN    "\033[32m"
@@ -43,6 +44,8 @@
 #undef LOG_TAG
 #define LOG_TAG "TIMER"
 
+
+/* output log functions define*/
 #if !defined(_D)
 #define _D(fmt, arg...) dlog_print(DLOG_DEBUG, \
 		LOG_TAG, "%s: %s(%d) > " WCOLOR_GREEN fmt WCOLOR_END, MODULE_INFO, \
diff --git a/inc/main.h b/inc/main.h
index bd8ea6b..b205e93 100755
--- a/inc/main.h
+++ b/inc/main.h
@@ -33,7 +33,6 @@
 #define GRP_MAIN "main"
 #define CONTROL_DOT "/time_picker_control_dot.png"
 #define MAX_PATH_LEN 1024
-#define GRP_MAIN_GEAR3		"main,gear3"
 #define GRP_MAIN_GEAR3_NEW		"main,gear3_new"
 #define BUF_SIZE 32
 #define BUF_SIZE_256 256
@@ -56,7 +55,9 @@
 #endif
 
 #define UPTIME_FILE  "/proc/uptime"
-
+/*
+ * @brief:enum to mark current or expected state of app
+ */
 typedef enum {
 	TMR_STATE_TYPE_RESET = 0,
 	TMR_STATE_TYPE_START,
@@ -65,12 +66,18 @@ typedef enum {
 	TMR_STATE_TYPE_MAX,
 } TMR_STATE_TYPE;
 
+/*
+ * @brief:enum to mark current or expected time type
+ */
 typedef enum {
 	TMR_TIME_TYPE_HOUR,
 	TMR_TIME_TYPE_MIN,
 	TMR_TIME_TYPE_SEC,
 } TMR_TIME_TYPE;
 
+/*
+ * @brief:enum to mark current or expected state of system type
+ */
 typedef enum {
 	TMR_SYSTIME_TYPE_USEC,
 	TMR_SYSTIME_TYPE_SEC,
@@ -86,14 +93,7 @@ struct lap_data {
 	char interval_data[20];	// to record the intarval time on the time pannel
 };
 
-typedef enum {
-	SAMPLE_APP_ERROR_OK = 0,
-	SAMPLE_APP_ERROR_FAIL = -1,
-	SAMPLE_APP_ERROR_INVALID_PARAMETER = -2,
-	SAMPLE_APP_ERROR_OUT_OF_MEMORY = -3,
-	SAMPLE_APP_ERROR_NO_DATA = -4,
-} sample_app_error_e;
-
+// define data structure for screenreader api with every readable object
 typedef struct screenreader_data {
 	Evas_Object* timer_title;
 	Evas_Object* hour_spinner;
@@ -157,7 +157,7 @@ typedef struct appdata {
 	Eina_Bool restart_flag;
 	Eina_Bool start_delaying;
 	Eina_Bool reset_delaying;
-	char timer_edj_path[MAX_PATH_LEN];
+	char timer_edj_path[MAX_PATH_LEN]; //path to
 	char timer_control_dot_path[MAX_PATH_LEN];
 	char edje_radio_theme_path[MAX_PATH_LEN];
 	Elm_Theme *theme;
diff --git a/src/main.c b/src/main.c
index 2f9457b..78ca107 100755
--- a/src/main.c
+++ b/src/main.c
@@ -1019,7 +1019,6 @@ void _launch_alert(void* data)
 		ret = device_display_change_state(DISPLAY_STATE_NORMAL);
 		TMR_INFO("set display status to normal: ret:%d", ret);
 	}
-	//int ret = device_power_wakeup(false);
 	app_control_create(&app_control);
 	app_control_set_operation(app_control, APP_CONTROL_OPERATION_DEFAULT);
 	app_control_set_app_id(app_control, "org.tizen.w-timer.alert");
diff --git a/timer_alert/inc/ring.h b/timer_alert/inc/ring.h
index 45d9e07..7abbee7 100755
--- a/timer_alert/inc/ring.h
+++ b/timer_alert/inc/ring.h
@@ -35,6 +35,10 @@
 #define GRP_MAIN "main"
 #define BUF_LEN 1024
 
+/*
+* @brief:  init sreeenreader for alert
+* @param[data]: in, pointer to appdata
+*/
 void _screen_reader_objects_create(void* data);
 
 #endif /* __ring_H__ */