Add some comments for hs-helper

[apps/agl-service-homescreen.git] / src / homescreen.cpp

diff --git a/src/homescreen.cpp b/src/homescreen.cpp
index 85ea99f..5de15b8 100644 (file)
--- a/src/homescreen.cpp
+++ b/src/homescreen.cpp
@@ -57,13 +57,13 @@ static void pingSample(struct afb_req request)
 /**
  * tap_shortcut notify for homescreen
  * When Shortcut area is tapped,  notify these applciations
-  *
+ *
  * #### Parameters
  * Request key
  * - application_name   : application name
  *
  * #### Return
- * Nothing
+ * None
  *
  */
 static void tap_shortcut (struct afb_req request)
@@ -100,7 +100,7 @@ static void tap_shortcut (struct afb_req request)
  * - display_message   : message for display
  *
  * #### Return
- * Nothing
+ * None
  *
  */
 static void on_screen_message (struct afb_req request)
@@ -137,7 +137,7 @@ static void on_screen_message (struct afb_req request)
  * - reply_message   : message for reply
  *
  * #### Return
- * Nothing
+ * None
  *
  */
 static void on_screen_reply (struct afb_req request)
@@ -173,9 +173,7 @@ static void on_screen_reply (struct afb_req request)
  *  - event  : Event name. Event list is written in libhomescreen.cpp
  *
  * #### Return
- * Nothing
- *
- * #### Note
+ * None
  *
  */
 static void subscribe(struct afb_req request)
@@ -213,9 +211,7 @@ static void subscribe(struct afb_req request)
  *  - event  : Event name. Event list is written in libhomescreen.cpp
  *
  * #### Return
- * Nothing
- *
- * #### Note
+ * None
  *
  */
 static void unsubscribe(struct afb_req request)
@@ -260,12 +256,32 @@ static const struct afb_verb_v2 verbs[]= {
     {NULL } /* marker for end of the array */
 };
 
+/**
+ * homescreen binding preinit function
+ *
+ * #### Parameters
+ *  - null
+ *
+ * #### Return
+ * None
+ *
+ */
 static int preinit()
 {
    HMI_NOTICE("homescreen-service","binding preinit (was register)");
    return 0;
 }
 
+/**
+ * homescreen binding init function
+ *
+ * #### Parameters
+ *  - null
+ *
+ * #### Return
+ * None
+ *
+ */
 static int init()
 {
    HMI_NOTICE("homescreen-service","binding init");
@@ -290,6 +306,17 @@ static int init()
    return 0;
 }
 
+/**
+ * homescreen binding event function
+ *
+ * #### Parameters
+ *  - event  : event name
+ *  - object : event json object
+ *
+ * #### Return
+ * None
+ *
+ */
 static void onevent(const char *event, struct json_object *object)
 {
    HMI_NOTICE("homescreen-service","on_event %s", event);