From bf24bcfb8fa3a1b2d43a42b78918fa95a6b96122 Mon Sep 17 00:00:00 2001
From: "gs86.lee" <gs86.lee@samsung.com>
Date: Tue, 12 Jan 2016 14:56:23 +0900
Subject: [PATCH] Add comments for new APIs

Change-Id: I699e5fab6ef56ce951c8dec4779c94c76837c921
---
 view.c | 49 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 47 insertions(+), 2 deletions(-)

diff --git a/view.c b/view.c
index 89b08b6..e6f1baa 100644
--- a/view.c
+++ b/view.c
@@ -429,7 +429,16 @@ void view_set_button(Evas_Object *parent, const char *part, const char *style, c
 	evas_object_show(btn);
 }
 
-void view_add_more_button_item(Evas_Object *parent, const char *part, const char *main_txt, const char *sub_txt, const char *img_path, void (clicked_cb)(void *data, Evas_Object *obj, void *event_info), void *user_data)
+/*
+ * @brief: Add a more button item
+ * @param[parent]: object that contains more button
+ * @param[main_txt]: text will be written in the middle of the selector
+ * @param[sub_txt] Text will be written under the main_txt
+ * @param[img_path]: path of image file will be used as more button item icon
+ * @param[clicked_cb]: function will be operated when the more button item is clicked
+ * @param[user_data]: data needed in this function
+ */
+void view_add_more_button_item(Evas_Object *parent, const char *part, const char *main_txt, const char *sub_txt, const char *img_path, Evas_Smart_Cb clicked_cb, void *user_data)
 {
 	Evas_Object *img = NULL;
 	Evas_Object *more_btn = NULL;
@@ -671,7 +680,13 @@ void view_set_customized_event_callback(Evas_Object *item, char *signal, char *s
 	elm_object_signal_callback_add(item, signal, source, signal_cb, user_data);
 }
 
-void view_set_rotary_event_callback(Evas_Object *parent, Eina_Bool (*rotary_cb)(void *data, Evas_Object *obj, Eext_Rotary_Event_Info *info), void *user_data)
+/*
+ * @brief: Register roatry event callback function.
+ * @param[obj]: object that will receive rotary event
+ * @param[rotary_cb]: function will be operated when rotary event happens
+ * @param[user_data]: data needed in this function
+ */
+void view_set_rotary_event_callback(Evas_Object *obj, Eext_Rotary_Event_Cb rotary_cb, void *user_data)
 {
 	if (parent == NULL) {
 		dlog_print(DLOG_ERROR, LOG_TAG, "parent is NULL.");
@@ -682,6 +697,10 @@ void view_set_rotary_event_callback(Evas_Object *parent, Eina_Bool (*rotary_cb)(
 	eext_rotary_object_event_callback_add(parent, rotary_cb, user_data);
 }
 
+/*
+ * @brief: Make a label and set label options.
+ * @param[parent]: The object to which you want to add this label
+ */
 Evas_Object *view_create_label(Evas_Object *parent)
 {
 	Evas_Object *label = elm_label_add(parent);
@@ -702,6 +721,12 @@ Evas_Object *view_create_label(Evas_Object *parent)
 	return label;
 }
 
+/*
+ * @brief: Set a text to label object
+ * @param[parent]: Object has part to which you want to set text
+ * @param[part]: Part name to which you want to set text
+ * @param[text]: text you want to set to the part
+ */
 void view_set_label_text(Evas_Object *parent, const char *part, const char *text)
 {
 	Evas_Object *label = NULL;
@@ -726,6 +751,11 @@ void view_set_label_text(Evas_Object *parent, const char *part, const char *text
 	elm_object_text_set(label, buf);
 }
 
+/*
+ * @brief: Set a label to given part
+ * @param[parent]: object has part to which you want to set this label
+ * @param[part]: part name to which you want to set this label
+ */
 void view_set_label(Evas_Object *parent, const char *part)
 {
 	Evas_Object *label = NULL;
@@ -744,6 +774,11 @@ void view_set_label(Evas_Object *parent, const char *part)
 	elm_object_part_content_set(parent, "sw.focus.txt", label);
 }
 
+/*
+ * @brief: Set a progressbar to given part
+ * @param[parent]: object has part to which you want to set this progressbar
+ * @param[part]: part name to which you want to set this progressbar
+ */
 void view_set_prgressbar(Evas_Object *parent, const char *part)
 {
 	Evas_Object *progressbar = NULL;
@@ -763,6 +798,12 @@ void view_set_prgressbar(Evas_Object *parent, const char *part)
 	elm_object_part_content_set(parent, part, progressbar);
 }
 
+/*
+ * @brief: Set value to a progressbar
+ * @param[parent]: object has part to which you want to set
+ * @param[part]: part name to which you want to set
+ * @param[val]: value to which you want to set
+ */
 void view_set_progressbar_val(Evas_Object *parent, const char *part, int val)
 {
 	Evas_Object *progressbar = NULL;
@@ -786,6 +827,10 @@ void view_set_progressbar_val(Evas_Object *parent, const char *part, int val)
 	eext_circle_object_value_set(progressbar, val);
 }
 
+/*
+ * @brief: Make a checkbox
+ * @param[parent]: The object to which you want to add this checkbox
+ */
 Evas_Object *view_create_checkbox(Evas_Object *parent)
 {
 	Evas_Object *check;
-- 
2.7.4