projects / platform / core / api / telephony.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 142a757)
Update the doxygen description of telephony_get_signal_strength() 95/126395/5 accepted/tizen/unified/20170426.195859 submit/tizen/20170426.062505 tizen_4.0.m1_release
authorsinikang <sinikang@samsung.com>
Fri, 21 Apr 2017 07:42:30 +0000 (16:42 +0900)
committersinikang <sinikang@samsung.com>
Tue, 25 Apr 2017 03:56:33 +0000 (12:56 +0900)
Change-Id: I34dcef30f6dd9ecd6fd3cb2795fd27d96ea7e415

include/telephony_network.h patch | blob | history

diff --git a/include/telephony_network.h b/include/telephony_network.h
index 2b858221968902e784041b8eda5d9590785ab316..61ab0cca8ca6adb953de92574b18238849817d04 100644 (file)
--- a/include/telephony_network.h
+++ b/include/telephony_network.h
@@ -54,21 +54,21 @@ typedef enum {
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 typedef enum {
-       TELEPHONY_NETWORK_TYPE_UNKNOWN,         /**< Unknown */
-       TELEPHONY_NETWORK_TYPE_GSM,             /**< 2G GSM network type */
-       TELEPHONY_NETWORK_TYPE_GPRS,            /**< 2.5G GPRS network type */
-       TELEPHONY_NETWORK_TYPE_EDGE,            /**< 2.5G EDGE network type */
-       TELEPHONY_NETWORK_TYPE_UMTS,            /**< 3G UMTS network type */
-       TELEPHONY_NETWORK_TYPE_HSDPA,           /**< HSDPA network type */
-       TELEPHONY_NETWORK_TYPE_LTE,             /**< LTE network type */
-       TELEPHONY_NETWORK_TYPE_IS95A,           /**< IS95A network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_IS95B,           /**< IS95B network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_CDMA_1X,         /**< CDMA 1x network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_EVDO_REV_0,      /**< EVDO revision 0 network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_EVDO_REV_A,      /**< EVDO revision A network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_EVDO_REV_B,      /**< EVDO revision B network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_EVDV,            /**< EVDV network type (Since: 3.0) */
-       TELEPHONY_NETWORK_TYPE_EHRPD,           /**< EHRPD network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_UNKNOWN,       /**< Unknown */
+       TELEPHONY_NETWORK_TYPE_GSM,           /**< 2G GSM network type */
+       TELEPHONY_NETWORK_TYPE_GPRS,          /**< 2.5G GPRS network type */
+       TELEPHONY_NETWORK_TYPE_EDGE,          /**< 2.5G EDGE network type */
+       TELEPHONY_NETWORK_TYPE_UMTS,          /**< 3G UMTS network type */
+       TELEPHONY_NETWORK_TYPE_HSDPA,         /**< HSDPA network type */
+       TELEPHONY_NETWORK_TYPE_LTE,           /**< LTE network type */
+       TELEPHONY_NETWORK_TYPE_IS95A,         /**< IS95A network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_IS95B,         /**< IS95B network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_CDMA_1X,       /**< CDMA 1x network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_EVDO_REV_0,    /**< EVDO revision 0 network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_EVDO_REV_A,    /**< EVDO revision A network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_EVDO_REV_B,    /**< EVDO revision B network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_EVDV,          /**< EVDV network type (Since: 3.0) */
+       TELEPHONY_NETWORK_TYPE_EHRPD,         /**< EHRPD network type (Since: 3.0) */
 } telephony_network_type_e;
 
 /**
@@ -76,11 +76,11 @@ typedef enum {
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
-       TELEPHONY_NETWORK_PS_TYPE_UNKNOWN,      /**< Unknown */
-       TELEPHONY_NETWORK_PS_TYPE_HSDPA,        /**< HSDPA ps type */
-       TELEPHONY_NETWORK_PS_TYPE_HSUPA,        /**< HSUPA ps type */
-       TELEPHONY_NETWORK_PS_TYPE_HSPA,         /**< HSPA ps type */
-       TELEPHONY_NETWORK_PS_TYPE_HSPAP,        /**< HSPAP ps type */
+       TELEPHONY_NETWORK_PS_TYPE_UNKNOWN,    /**< Unknown */
+       TELEPHONY_NETWORK_PS_TYPE_HSDPA,      /**< HSDPA ps type */
+       TELEPHONY_NETWORK_PS_TYPE_HSUPA,      /**< HSUPA ps type */
+       TELEPHONY_NETWORK_PS_TYPE_HSPA,       /**< HSPA ps type */
+       TELEPHONY_NETWORK_PS_TYPE_HSPAP,      /**< HSPAP ps type */
 } telephony_network_ps_type_e;
 
 /**
@@ -88,9 +88,9 @@ typedef enum {
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 typedef enum {
-       TELEPHONY_NETWORK_SERVICE_STATE_IN_SERVICE,     /**< In service */
-       TELEPHONY_NETWORK_SERVICE_STATE_OUT_OF_SERVICE, /**< Out of service */
-       TELEPHONY_NETWORK_SERVICE_STATE_EMERGENCY_ONLY, /**< Only emergency call is allowed */
+       TELEPHONY_NETWORK_SERVICE_STATE_IN_SERVICE,     /**< In service */
+       TELEPHONY_NETWORK_SERVICE_STATE_OUT_OF_SERVICE, /**< Out of service */
+       TELEPHONY_NETWORK_SERVICE_STATE_EMERGENCY_ONLY, /**< Only emergency call is allowed */
 } telephony_network_service_state_e;
 
 /**
@@ -98,10 +98,10 @@ typedef enum {
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
-       TELEPHONY_NETWORK_NAME_OPTION_UNKNOWN,  /**< Unknown */
-       TELEPHONY_NETWORK_NAME_OPTION_SPN,      /**< Network name displayed by SPN */
-       TELEPHONY_NETWORK_NAME_OPTION_NETWORK,  /**< Network name displayed by Network */
-       TELEPHONY_NETWORK_NAME_OPTION_ANY,      /**< Network name displayed by SPN or Network */
+       TELEPHONY_NETWORK_NAME_OPTION_UNKNOWN,  /**< Unknown */
+       TELEPHONY_NETWORK_NAME_OPTION_SPN,      /**< Network name displayed by SPN */
+       TELEPHONY_NETWORK_NAME_OPTION_NETWORK,  /**< Network name displayed by Network */
+       TELEPHONY_NETWORK_NAME_OPTION_ANY,      /**< Network name displayed by SPN or Network */
 } telephony_network_name_option_e;
 
 /**
@@ -109,9 +109,9 @@ typedef enum {
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
-       TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_UNKNOWN = -1,       /**< Unknown status */
-       TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_SIM1 = 0,           /**< SIM 1 */
-       TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_SIM2                /**< SIM 2 */
+       TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_UNKNOWN = -1,    /**< Unknown status */
+       TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_SIM1 = 0,        /**< SIM 1 */
+       TELEPHONY_NETWORK_DEFAULT_DATA_SUBS_SIM2             /**< SIM 2 */
 } telephony_network_default_data_subs_e;
 
 /**
@@ -119,9 +119,9 @@ typedef enum {
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
-       TELEPHONY_NETWORK_DEFAULT_SUBS_UNKNOWN = -1,    /**< Unknown status */
-       TELEPHONY_NETWORK_DEFAULT_SUBS_SIM1 = 0,        /**< SIM 1 network */
-       TELEPHONY_NETWORK_DEFAULT_SUBS_SIM2             /**< SIM 2 network */
+       TELEPHONY_NETWORK_DEFAULT_SUBS_UNKNOWN = -1,    /**< Unknown status */
+       TELEPHONY_NETWORK_DEFAULT_SUBS_SIM1 = 0,        /**< SIM 1 network */
+       TELEPHONY_NETWORK_DEFAULT_SUBS_SIM2             /**< SIM 2 network */
 } telephony_network_default_subs_e;
 
 /**
@@ -129,8 +129,8 @@ typedef enum {
  * @since_tizen 3.0
  */
 typedef enum {
-       TELEPHONY_NETWORK_SELECTION_MODE_AUTOMATIC,     /**< Automatic mode */
-       TELEPHONY_NETWORK_SELECTION_MODE_MANUAL         /**< Manual mode */
+       TELEPHONY_NETWORK_SELECTION_MODE_AUTOMATIC,    /**< Automatic mode */
+       TELEPHONY_NETWORK_SELECTION_MODE_MANUAL        /**< Manual mode */
 } telephony_network_selection_mode_e;
 
 /**
@@ -145,7 +145,7 @@ typedef enum {
  *     http://tizen.org/privilege/telephony privilege is no longer required since 3.0.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] lac The Location Area Code, @c -1 if unknown
+ * @param[out] lac   The Location Area Code, @c -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -172,7 +172,7 @@ int telephony_network_get_lac(telephony_h handle, int *lac);
  *     http://tizen.org/privilege/location.coarse privilege is required to use this API since 3.0. @n
  *     http://tizen.org/privilege/telephony privilege is no longer required since 3.0.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle   The handle from telephony_init()
  * @param[out] cell_id The cell identification number, @c -1 if unknown
  *
  * @return @c 0 on success,
@@ -197,8 +197,8 @@ int telephony_network_get_cell_id(telephony_h handle, int *cell_id);
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] rssi The Received Signal Strength Indicator \n
- *                  Higher the received number, the stronger the signal strength
+ * @param[out] rssi  The Received Signal Strength Indicator \n
+ *                   Higher the received number, the stronger the signal strength
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -218,7 +218,7 @@ int telephony_network_get_rssi(telephony_h handle, telephony_network_rssi_e *rss
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle  The handle from telephony_init()
  * @param[out] status @c true if roaming,
  *                    otherwise @c false if not roaming
  *
@@ -244,8 +244,8 @@ int telephony_network_get_roaming_status(telephony_h handle, bool *status);
  *          You must release @c mcc using free() on success case, empty string if unknown.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] mcc The Mobile Country Code (three digits)
- *                 Mobile Country Code (MCC) identifies the country where the cell is being used
+ * @param[out] mcc   The Mobile Country Code (three digits)
+ *                   Mobile Country Code (MCC) identifies the country where the cell is being used
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -269,8 +269,8 @@ int telephony_network_get_mcc(telephony_h handle, char **mcc);
  *          You must release @c mnc using free() on success case, empty string if unknown.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] mnc The Mobile Network Code (three digits)
- *                 The Mobile Network Code (MNC) identifies the mobile phone operator and network provider
+ * @param[out] mnc   The Mobile Network Code (three digits)
+ *                   The Mobile Network Code (MNC) identifies the mobile phone operator and network provider
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -293,7 +293,7 @@ int telephony_network_get_mnc(telephony_h handle, char **mnc);
  * @remarks This API can be used in GSM / WCDMA / LTE network.
  *          You must release @c network_name using free() on success case.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle        The handle from telephony_init()
  * @param[out] network_name The name of the current registered network, empty string if unknown
  *
  * @return @c 0 on success,
@@ -316,7 +316,7 @@ int telephony_network_get_network_name(telephony_h handle, char **network_name);
  *
  * @remarks This API can be used in case network is in service.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle        The handle from telephony_init()
  * @param[out] network_type The network service type
  *
  * @return @c 0 on success,
@@ -342,7 +342,7 @@ int telephony_network_get_type(telephony_h handle, telephony_network_type_e *net
  *
  * @remarks This API can be used in HSDPA network.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle   The handle from telephony_init()
  * @param[out] ps_type The type of packet service
  *
  * @return @c 0 on success,
@@ -366,7 +366,7 @@ int telephony_network_get_ps_type(telephony_h handle, telephony_network_ps_type_
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle               The handle from telephony_init()
  * @param[out] network_name_option The network name display option
  *
  * @return @c 0 on success,
@@ -390,7 +390,7 @@ int telephony_network_get_network_name_option(telephony_h handle, telephony_netw
  *
  * @remarks To know the state of data network, refer connection API.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle                 The handle from telephony_init()
  * @param[out] network_service_state The current network state
  *
  * @return @c 0 on success,
@@ -413,7 +413,7 @@ int telephony_network_get_service_state(telephony_h handle, telephony_network_se
  * @privilege %http://tizen.org/privilege/telephony
  *
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle       The handle from telephony_init()
  * @param[out] default_sub The current default data subscription
  *
  * @return @c 0 on success,
@@ -436,7 +436,7 @@ int telephony_network_get_default_data_subscription(telephony_h handle, telephon
  * @privilege %http://tizen.org/privilege/telephony
  *
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle       The handle from telephony_init()
  * @param[out] default_sub The current default voice subscription
  *
  * @return @c 0 on success,
@@ -459,7 +459,7 @@ int telephony_network_get_default_subscription(telephony_h handle, telephony_net
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] mode The network selection mode
+ * @param[out] mode  The network selection mode
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -483,7 +483,7 @@ int telephony_network_get_selection_mode(telephony_h handle, telephony_network_s
  * @remarks This API can be used in LTE network.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] tac The Tracking Area Code, @c -1 if unknown
+ * @param[out] tac   The Tracking Area Code, @c -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -509,7 +509,7 @@ int telephony_network_get_tac(telephony_h handle, int *tac);
  * @remarks This API can be used in CDMA network.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] sid The system ID, @c -1 if unknown
+ * @param[out] sid   The system ID, @c -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -535,7 +535,7 @@ int telephony_network_get_system_id(telephony_h handle, int *sid);
  * @remarks This API can be used in CDMA network.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] nid The network ID, @c -1 if unknown
+ * @param[out] nid   The network ID, @c -1 if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -586,7 +586,7 @@ int telephony_network_get_base_station_id(telephony_h handle, int *bs_id);
  *
  * @remarks This API can be used in CDMA network.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle       The handle from telephony_init()
  * @param[out] bs_latitude The base station latitude, @c 0x7FFFFFFF if unknown
  *
  * @return @c 0 on success,
@@ -612,7 +612,7 @@ int telephony_network_get_base_station_latitude(telephony_h handle, int *bs_lati
  *
  * @remarks This API can be used in CDMA network.
  *
- * @param[in] handle The handle from telephony_init()
+ * @param[in] handle        The handle from telephony_init()
  * @param[out] bs_longitude The base station longitude, @c 0x7FFFFFFF if unknown
  *
  * @return @c 0 on success,
@@ -630,15 +630,15 @@ int telephony_network_get_base_station_latitude(telephony_h handle, int *bs_lati
 int telephony_network_get_base_station_longitude(telephony_h handle, int *bs_longitude);
 
 /**
- * @brief Gets the Signal Strength (Received Signal Strength in dBm).
+ * @brief Gets the received signal strength (dBm).
  *
  * @since_tizen 4.0
  * @privlevel public
  * @privilege %http://tizen.org/privilege/telephony
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] dbm The Received Signal Strength in dBm, @c 0 if unknown \n
- *                  Higher the received number, the stronger the signal strength
+ * @param[out] dbm   The received signal strength in dBm, @c 0 if unknown \n
+ *                   The higher the received number, the stronger the signal
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
Domain: Network & Connectivity / Telephony;