From: Wootak Jung <wootak.jung@samsung.com>
Date: Tue, 16 Feb 2016 02:47:59 +0000 (+0900)
Subject: Complemented api documentations
X-Git-Tag: submit/tizen/20160303.013045~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6e34316520bf381fe214e5567fa1f2abb8d89b8c;p=platform%2Fcore%2Fapi%2Ftelephony.git

Complemented api documentations

Change-Id: Iad26a7de072dbd1212df50c99ce72b850a7c1646
---

diff --git a/include/telephony_network.h b/include/telephony_network.h
index af9ed3b..e50cd9e 100644
--- a/include/telephony_network.h
+++ b/include/telephony_network.h
@@ -140,6 +140,9 @@ typedef enum {
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c lac)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] lac The Location Area Code, -1 if unknown
  *
@@ -165,6 +168,9 @@ int telephony_network_get_lac(telephony_h handle, int *lac);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c cell_id)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] cell_id The cell identification number, -1 if unknown
  *
@@ -494,6 +500,9 @@ int telephony_network_get_selection_mode(telephony_h handle,
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c tac)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] tac The Tracking Area Code, -1 if unknown
  *
@@ -521,6 +530,9 @@ int telephony_network_get_tac(telephony_h handle, int *tac);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c sid)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] sid The system ID, -1 if unknown
  *
@@ -548,6 +560,9 @@ int telephony_network_get_system_id(telephony_h handle, int *sid);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c nid)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] nid The network ID, -1 if unknown
  *
@@ -575,6 +590,9 @@ int telephony_network_get_network_id(telephony_h handle, int *nid);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c bs_id)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] bs_id The base station ID, -1 if unknown
  *
@@ -602,6 +620,9 @@ int telephony_network_get_base_station_id(telephony_h handle, int *bs_id);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c bs_latitude)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] bs_latitude The base station latitude, 0x7FFFFFFF if unknown
  *
@@ -629,6 +650,9 @@ int telephony_network_get_base_station_latitude(telephony_h handle, int *bs_lati
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
+ * @remarks This API returns #TELEPHONY_ERROR_NONE with unknown value (@c bs_longitude)
+ *          if precondition is not be satisfied.
+ *
  * @param[in] handle The handle from telephony_init()
  * @param[out] bs_longitude The base station longitude, 0x7FFFFFFF if unknown
  *