Add doxygen document for invalid out-param 48/59148/1
authorWootak Jung <wootak.jung@samsung.com>
Thu, 11 Feb 2016 04:56:03 +0000 (13:56 +0900)
committerWootak Jung <wootak.jung@samsung.com>
Thu, 11 Feb 2016 04:56:03 +0000 (13:56 +0900)
Change-Id: I49c463bd012657bfd983d6603165a04340b360be

include/telephony_network.h
packaging/capi-telephony.spec

index be4e4fea3d655549a920badc450580fa01e90c10..af9ed3bb4934c293d78f638e948b391e84fbc418 100644 (file)
@@ -141,7 +141,7 @@ typedef enum {
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] lac The Location Area Code
+ * @param[out] lac The Location Area Code, -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -166,7 +166,7 @@ int telephony_network_get_lac(telephony_h handle, int *lac);
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] cell_id The cell identification number
+ * @param[out] cell_id The cell identification number, -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -495,7 +495,7 @@ int telephony_network_get_selection_mode(telephony_h handle,
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] tac The Tracking Area Code
+ * @param[out] tac The Tracking Area Code, -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -522,7 +522,7 @@ int telephony_network_get_tac(telephony_h handle, int *tac);
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] sid The system ID
+ * @param[out] sid The system ID, -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -549,7 +549,7 @@ int telephony_network_get_system_id(telephony_h handle, int *sid);
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] nid The network ID
+ * @param[out] nid The network ID, -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -576,7 +576,7 @@ int telephony_network_get_network_id(telephony_h handle, int *nid);
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] bs_id The base station ID
+ * @param[out] bs_id The base station ID, -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -603,7 +603,7 @@ int telephony_network_get_base_station_id(telephony_h handle, int *bs_id);
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] bs_latitude The base station latitude
+ * @param[out] bs_latitude The base station latitude, 0x7FFFFFFF if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -630,7 +630,7 @@ int telephony_network_get_base_station_latitude(telephony_h handle, int *bs_lati
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] bs_longitude The base station longitude
+ * @param[out] bs_longitude The base station longitude, 0x7FFFFFFF if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
index 80932273caca3c2c93c71ca937ea1c252e9f619c..2a864dc9650bc4046503379bc9606e0a9fe3812e 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-telephony
 Summary:    Telephony Core API
-Version:    0.1.57
+Version:    0.1.58
 Release:    1
 Group:      System/Libraries
 License:    Apache-2.0