Change document

1. change contents refer to doxygen files to fit with markdown syntax.
2. remove destination in api-services-book.yml.
3. fix some issues.

Bug-AGL: SPEC-2326

Change-Id: I277326a1ef0205aa690db5398c72f74f6fc0e04a
Signed-off-by: wang_zhiqiang <wang_zhiqiang@dl.cn.nexty-ele.com>

diff --git a/doc/ApplicationGuide.md b/doc/ApplicationGuide.md
index aaf7bd7..f0de4d7 100644 (file)
--- a/doc/ApplicationGuide.md
+++ b/doc/ApplicationGuide.md
@@ -46,7 +46,7 @@ You can find these projects in AGL gerrit.
 
 - [homescreen(HomeScreenGUI)](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/homescreen)
 - [launcher(LauncherGUI)](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/launcher)
-- [gl-service-homescreen(HomeScreenBinder's binding library)](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/agl-service-homescreen)
+- [agl-service-homescreen(HomeScreenBinder's binding library)](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/apps/agl-service-homescreen)
 - [libhomescreen(library for application to communication with HomeScreenBinder](    https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/libhomescreen)
 - [libqthomescreen(library for qt application to communication with HomeScreenBinder based on libhomescreen)](https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/libqthomescreen)
 
@@ -182,22 +182,101 @@ The communication protocols between libhomescreen and upper binder, upper binder
 
 ### HomeScreen Specific API
 
-- [LibHomeScreen ()](api-ref/html/de/dd0/class_lib_home_screen.html#a724bd949c4154fad041f96a15ef0f5dc)
-- [init (const int port, const std::string &token)](api-ref/html/de/dd0/class_lib_home_screen.html#a6a57b573cc767725762ba9beab032220)
-- [tapShortcut(const char *application_id)](api-ref/html/de/dd0/class_lib_home_screen.html#a6ca8ff4a2aa019a735afaff713e0ef44)
-- [onScreenMessage(const char *display_message)](api-ref/html/de/dd0/class_lib_home_screen.html#ac336482036a72b51a822725f1929523c)
-- [onScreenReply(const char *reply_message)](api-ref/html/de/dd0/class_lib_home_screen.html#a6c065f41f2c5d1f58d2763bfb4da9c37)
-- [registerCallback (void(*event_cb)(const std::string &event, struct json_object *event_contents), void(*reply_cb)(struct json_object *reply_contents), void(*hangup_cb)(void)=nullptr)](api-ref/html/de/dd0/class_lib_home_screen.html#a2789e8a5372202cc36f48e71dbb9b7cf)
-- [set\_event\_handler(enum EventType et, handler_func f)](api-ref/html/de/dd0/class_lib_home_screen.html#ab1b0e08bf35415de9064afed899e9f85)
-- [call (const string& verb, struct json_object* arg)](api-ref/html/de/dd0/class_lib_home_screen.html#a527b49dcfe581be6275d0eb2236ba37f)
-- [call (const char* verb, struct json_object* arg)](api-ref/html/de/dd0/class_lib_home_screen.html#ab5e8e8ab7d53e0f114e9e907fcbb7643)
-- [subscribe (const string& event_name)](api-ref/html/de/dd0/class_lib_home_screen.html#aa4c189807b75d070f567967f0d690738)
-- [unsubscribe (const string& event_name)](api-ref/html/de/dd0/class_lib_home_screen.html#aac03a45cbd453ba69ddb00c1016930a6)
-- [showWindow (const char* application_id, json_object* json)](api-ref/html/de/dd0/class_lib_home_screen.html#a69fc770cb3f94d30a10c2c8c81eb892f)
-- [hideWindow (const char* application_id)](api-ref/html/de/dd0/class_lib_home_screen.html#a4dbaea6c7b310e8ce7207155ff11b32a)
-- [replyShowWindow (const char* application_id, json_object* json)](api-ref/html/de/dd0/class_lib_home_screen.html#a6310b129fc85ef0623e2e2063950cc4b)
-- [showNotification (json_object* json)](api-ref/html/de/dd0/class_lib_home_screen.html#a93ad567ed597a80a344ba82457c2bd7f)
-- [showInformation (json_object* json)](api-ref/html/de/dd0/class_lib_home_screen.html#ada999aeb0444c964428bdf1ee236727f)
+- LibHomeScreen::init (const int port, const std::string &token)
+```
+    port [in] : This argument should be specified to the port number to be used for websocket
+    token [in] : This argument should be specified to the token to be used for websocket
+
+    Create connection to homescreen-service by port and token which provided by
+    application framework. This API must be called before calling other api.
+```
+- LibHomeScreen::tapShortcut(const char *application_id)
+```
+    application_id [in] : Tapped application id (label)
+
+    This api is deprecated, recommend using showWindow.
+```
+- LibHomeScreen::onScreenMessage(const char *display_message)
+```
+    display_message [in] : message for display
+
+    This api is deprecated, recommend using showWindow/hideWindow to call onscreenapp.
+```
+- LibHomeScreen::onScreenReply(const char *reply_message)
+```
+    reply_message [in] : message for reply
+
+    This api is deprecated, recommend using replyShowWindow.
+```
+- LibHomeScreen::registerCallback(void(*event_cb)(const std::string &event, struct json_object *event_contents), void(*reply_cb)(struct json_object *reply_contents), void(*hangup_cb)(void)=nullptr)
+```
+    event_cb [in] : This argument should be specified to the callback for subscribed event
+    reply_cb [in] : This argument should be specified to the reply callback for call function
+    hangup_cb [in] : This argument should be specified to the hangup callback for call function
+
+    This api is deprecated, recommend using set_event_handler.
+```
+- LibHomeScreen::set_event_handler(enum EventType et, handler_func f)
+```
+    et [in] : event name
+    f [in] : event handler
+
+    Setting event handler for Homescreen-Service Event.
+```
+- LibHomeScreen::call(const string& verb, struct json_object* arg)
+- LibHomeScreen::call(const char* verb, struct json_object* arg)
+```
+    verb [in] : This argument should be specified to the API name (e.g. "tap_shortcut")
+    arg [in] : This argument should be specified to the argument of API.
+    And this argument expects JSON object
+
+    Call homescreen-service verb.
+```
+- LibHomeScreen::subscribe(const string& event_name)
+```
+    event_name [in] : This argument should be specified to the event name
+
+    Subscribe homescreen-service event. Deprecated, recommend using set_event_handler.
+```
+- LibHomeScreen::unsubscribe(const string& event_name)
+```
+    event_name [in] : This argument should be specified to the event name
+
+    Unsubscribe homescreen-service event. Deprecated, recommend using set_event_handler.
+```
+- LibHomeScreen::showWindow(const char* application_id, json_object* json)
+```
+    application_id [in] : This argument should be specified to the application's id
+    json [in] : This argument should be specified to the json parameters
+
+    Request to show the window of application_id, and set display area in json liked
+    {"area":"normal.full"}.
+```
+- LibHomeScreen::hideWindow(const char* application_id)
+```
+    application_id [in] : This argument should be specified to the application's id
+
+    Request to hide the window of application_id.
+```
+- LibHomeScreen::replyShowWindow(const char* application_id, json_object* json)
+```
+    application_id [in] : This argument should be specified to the onscreen reply to applilcation id
+    json [in] : This argument should be specified to the json parameters
+
+    Post reply information to who called showWindow.
+```
+- LibHomeScreen::showNotification(json_object* json)
+```
+    json [in] : This argument should be specified to the json parameters.
+
+    Post Notification to Homescreen which will display at top area of Homescreen.
+```
+- LibHomeScreen::showInformation(json_object* json)
+```
+    json [in] : This argument should be specified to the json parameters.
+
+    Post Information to Homescreen which will display at bottom area of Homescreen.
+```
 
 * * *
 
@@ -236,7 +315,7 @@ You can find sample implementation of HomeScreen as below.
 * * *
 
 ## Limitation
-Now OnScreenApp is developing,approximately it will finished at GG.
+None.
 
 * * *
 

diff --git a/doc/api-services-book.yml b/doc/api-services-book.yml
index b4e5ba5..d2400d1 100644 (file)
--- a/doc/api-services-book.yml
+++ b/doc/api-services-book.yml
@@ -9,5 +9,4 @@ books:
     version: master
     chapters:
     - url: ApplicationGuide.md
-      destination: 3_1-HomeScreen-Guide.md
       name: Home Screen Developper Guide
\ No newline at end of file