From: Dongyoung Kim <dydot1.kim@samsung.com>
Date: Mon, 4 Jan 2016 08:16:12 +0000 (+0900)
Subject: [Common] Add the example code for getting error message
X-Git-Tag: submit/tizen/20160105.010457^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e72093e67d03309248873ec1a985f9c40eeb1e1d;p=platform%2Fcore%2Fapi%2Fcommon.git

[Common] Add the example code for getting error message

Change-Id: I0be92c7eff056d124732a48c8cbfe7304ede2dde
---

diff --git a/include/tizen_error.h b/include/tizen_error.h
index 8abd87c..a0e0923 100644
--- a/include/tizen_error.h
+++ b/include/tizen_error.h
@@ -491,6 +491,21 @@ extern "C" {
  * @return The error's message
  *
  * @see #tizen_error_e
+ *
+ * @code
+ *
+ *  char* errMsg;
+ *  location_manager_h location_handle;
+ *  int result = location_manager_create(LOCATION_METHOD_GPS, &location_handle);
+ *
+ *  if (LOCATIONS_ERROR_NONE != result)
+ *  {
+ *    errMsg = get_error_message(result);
+ *    dlog_print(DLOG_INFO, "MyTag", "%s", errMsg);
+ *  }
+ *
+ * @endcode
+ *
  */
 	char *get_error_message(int err);