Apply standard inspection result for native API doxygen 25/105625/1 accepted/tizen/common/20161221.183303 accepted/tizen/common/20170111.155022 accepted/tizen/ivi/20161221.034216 accepted/tizen/mobile/20161221.034118 accepted/tizen/tv/20161221.034137 accepted/tizen/wearable/20161221.034156 submit/tizen/20161220.211826 submit/tizen_common/20170111.150147
authorsinikang <sinikang@samsung.com>
Mon, 19 Dec 2016 06:41:47 +0000 (15:41 +0900)
committersinikang <sinikang@samsung.com>
Mon, 19 Dec 2016 06:41:47 +0000 (15:41 +0900)
Change-Id: I5f6b19f147ccad9c45314e710b0155da2dd6163e

include/telephony_call.h
include/telephony_common.h
include/telephony_modem.h
include/telephony_network.h
include/telephony_sim.h
packaging/capi-telephony.spec

index 6975886bd9bd925f65ff256cd2a699b1f64eee8e..f94d14d755019d433aad158369acd4c6566e73d0 100644 (file)
@@ -185,8 +185,8 @@ int telephony_call_get_preferred_voice_subscription(telephony_h handle, telephon
  * @remarks You must release @c call_list using telephony_call_release_call_list().
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] count Count of the existing calls.
- * @param[out] call_list List of call information for existing calls.
+ * @param[out] count Count of the existing calls
+ * @param[out] call_list List of call information for existing calls
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -197,11 +197,11 @@ int telephony_call_get_preferred_voice_subscription(telephony_h handle, telephon
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_call_get_call_list(telephony_h handle,
-       unsigned int *count, telephony_call_h **call_list);
+int telephony_call_get_call_list(telephony_h handle, unsigned int *count, telephony_call_h **call_list);
+
 
 /**
- * @brief Releases the list allocated from #telephony_call_get_call_list()
+ * @brief Releases the list allocated from #telephony_call_get_call_list().
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -215,7 +215,7 @@ int telephony_call_get_call_list(telephony_h handle,
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call list should be validated from #telephony_call_get_call_list()
+ * @pre The call list should be validated from #telephony_call_get_call_list().
  */
 int telephony_call_release_call_list(unsigned int count, telephony_call_h **call_list);
 
@@ -225,7 +225,7 @@ int telephony_call_release_call_list(unsigned int count, telephony_call_h **call
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] call_handle The handle from #telephony_call_get_call_list()
- * @param[out] handle_id The id of the call handle
+ * @param[out] handle_id The ID of the call handle
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -234,8 +234,8 @@ int telephony_call_release_call_list(unsigned int count, telephony_call_h **call
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list()
- * @post The call list should be released by using #telephony_call_release_call_list()
+ * @pre The call handle should be obtained from #telephony_call_get_call_list().
+ * @post The call list should be released by using #telephony_call_release_call_list().
  */
 int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *handle_id);
 
@@ -256,8 +256,8 @@ int telephony_call_get_handle_id(telephony_call_h call_handle, unsigned int *han
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list()
- * @post The call list should be released by using #telephony_call_release_call_list()
+ * @pre The call handle should be obtained from #telephony_call_get_call_list().
+ * @post The call list should be released by using #telephony_call_release_call_list().
  */
 int telephony_call_get_number(telephony_call_h call_handle, char **number);
 
@@ -276,8 +276,8 @@ int telephony_call_get_number(telephony_call_h call_handle, char **number);
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list()
- * @post The call list should be released by using #telephony_call_release_call_list()
+ * @pre The call handle should be obtained from #telephony_call_get_call_list().
+ * @post The call list should be released by using #telephony_call_release_call_list().
  */
 int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e *type);
 
@@ -296,8 +296,8 @@ int telephony_call_get_type(telephony_call_h call_handle, telephony_call_type_e
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list()
- * @post The call list should be released by using #telephony_call_release_call_list()
+ * @pre The call handle should be obtained from #telephony_call_get_call_list().
+ * @post The call list should be released by using #telephony_call_release_call_list().
  */
 int telephony_call_get_status(telephony_call_h call_handle, telephony_call_status_e *status);
 
@@ -315,8 +315,8 @@ int telephony_call_get_status(telephony_call_h call_handle, telephony_call_statu
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list()
- * @post The call list should be released by using #telephony_call_release_call_list()
+ * @pre The call handle should be obtained from #telephony_call_get_call_list().
+ * @post The call list should be released by using #telephony_call_release_call_list().
  */
 int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_direction_e *direction);
 
@@ -325,7 +325,7 @@ int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_di
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] call_handle The handle from #telephony_call_get_call_list()
- * @param[out] conference_status The value whether the call is conference call or not.
+ * @param[out] conference_status The value whether the call is conference call or not
  *                            (true: Conference call, false: Single call)
  *
  * @return @c 0 on success,
@@ -335,8 +335,8 @@ int telephony_call_get_direction(telephony_call_h call_handle, telephony_call_di
  * @retval #TELEPHONY_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  *
- * @pre The call handle should be obtained from #telephony_call_get_call_list()
- * @post The call list should be released by using #telephony_call_release_call_list()
+ * @pre The call handle should be obtained from #telephony_call_get_call_list().
+ * @post The call list should be released by using #telephony_call_release_call_list().
  */
 int telephony_call_get_conference_status(telephony_call_h call_handle, bool *conference_status);
 
index b7fe6250b86fd394bd13aee073fcc7b6eb035016..db256862823c6170dae4c26cf61c924e177ec1eb 100644 (file)
@@ -47,7 +47,7 @@ typedef struct telephony_data *telephony_h;
 /**
  * @brief The structure type for the list of handles to use the Telephony API.
  * @remarks There are two handles in case of dual SIM device. \n
- *          In this case, handle[0] is mean Primary SIM and handle[1] is mean Secondary SIM.
+ *          In this case, handle[0] means Primary SIM and handle[1] means Secondary SIM.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
 typedef struct {
@@ -183,7 +183,7 @@ typedef void (*telephony_noti_cb)(telephony_h handle, telephony_noti_e noti_id,
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks An application should have the privilege corresponding to each notificaiton id. \n
+ * @remarks An application should have the privilege corresponding to each notificaiton ID. \n
  *     Please see the #telephony_noti_e to know the privilege. \n
  *     If an application has no proper privilege, callback will not be invoked although API returns success.
  *
@@ -204,8 +204,8 @@ typedef void (*telephony_noti_cb)(telephony_h handle, telephony_noti_e noti_id,
  *
  * @see telephony_unset_noti_cb()
  */
-int telephony_set_noti_cb(telephony_h handle,
-       telephony_noti_e noti_id, telephony_noti_cb cb, void *user_data);
+int telephony_set_noti_cb(telephony_h handle, telephony_noti_e noti_id, telephony_noti_cb cb, void *user_data);
+
 
 /**
  * @brief Unsets a callback function.
@@ -233,7 +233,7 @@ int telephony_unset_noti_cb(telephony_h handle, telephony_noti_e noti_id);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You will get two handles in case of dual SIM device. \n
- *          In this case, handle[0] is mean Primary SIM and handle[1] is mean Secondary SIM.
+ *          In this case, handle[0] means Primary SIM and handle[1] means Secondary SIM.
  *
  * @param[out] list The list contains the number of
  *                  available handles and array of handles
@@ -286,11 +286,11 @@ typedef enum {
 typedef void (*telephony_state_changed_cb)(telephony_state_e state, void *user_data);
 
 /**
- * @brief Acquires the telephony state value
+ * @brief Acquires the telephony state value.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @param[out] state The state value of telephony.
+ * @param[out] state The state value of telephony
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
index d2cfd1901324d6545429cd6d140e69f268abbe30..1ef8d018f23de3eb2073ada2a61782b2f7d0eb81 100644 (file)
@@ -71,7 +71,7 @@ typedef enum {
 int telephony_modem_get_imei(telephony_h handle, char **imei);
 
 /**
- * @brief Gets the power status of the modem
+ * @brief Gets the power status of the modem.
  *
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
@@ -89,11 +89,11 @@ int telephony_modem_get_imei(telephony_h handle, char **imei);
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_modem_get_power_status(telephony_h handle,
-       telephony_modem_power_status_e *status);
+int telephony_modem_get_power_status(telephony_h handle, telephony_modem_power_status_e *status);
+
 
 /**
- * @brief Gets the MEID (Mobile Equipment Identifier) of a mobile phone. (for CDMA)
+ * @brief Gets the MEID (Mobile Equipment Identifier) of a mobile phone (for CDMA).
  *
  * @since_tizen 3.0
  * @privlevel public
index 106d57e1d09f76e057867870116017a2fc84eb34..57ec013d4a5ceed2d18820c6923fb8c57ed4aca7 100644 (file)
@@ -115,7 +115,7 @@ typedef enum {
 } telephony_network_default_data_subs_e;
 
 /**
- * @brief Enumeration defines possible 'default' Subscriptions for Circuit Switched(CS).
+ * @brief Enumeration for defining possible 'default' Subscriptions for Circuit Switched(CS).
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
@@ -198,7 +198,7 @@ int telephony_network_get_cell_id(telephony_h handle, int *cell_id);
  *
  * @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.
+ *                  Higher the received number, the stronger the signal strength
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -245,7 +245,7 @@ int telephony_network_get_roaming_status(telephony_h handle, bool *status);
  *
  * @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.
+ *                 Mobile Country Code (MCC) identifies the country where the cell is being used
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -270,7 +270,7 @@ int telephony_network_get_mcc(telephony_h handle, char **mcc);
  *
  * @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.
+ *                 The Mobile Network Code (MNC) identifies the mobile phone operator and network provider
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -294,7 +294,7 @@ int telephony_network_get_mnc(telephony_h handle, char **mnc);
  *          You must release @c network_name using free() on success case.
  *
  * @param[in] handle The handle from telephony_init()
- * @param[out] network_name The name of the current registered network, empty string if unknown.
+ * @param[out] network_name The name of the current registered network, empty string if unknown
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -330,8 +330,8 @@ int telephony_network_get_network_name(telephony_h handle, char **network_name);
  *
  * @see telephony_network_get_service_state()
  */
-int telephony_network_get_type(telephony_h handle,
-       telephony_network_type_e *network_type);
+int telephony_network_get_type(telephony_h handle, telephony_network_type_e *network_type);
+
 
 /**
  * @brief Gets the packet service type of the current registered network.
@@ -378,8 +378,8 @@ int telephony_network_get_ps_type(telephony_h handle, telephony_network_ps_type_
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_network_get_network_name_option(telephony_h handle,
-       telephony_network_name_option_e *network_name_option);
+int telephony_network_get_network_name_option(telephony_h handle, telephony_network_name_option_e *network_name_option);
+
 
 /**
  * @brief Gets the current network state of the telephony service.
@@ -402,8 +402,8 @@ int telephony_network_get_network_name_option(telephony_h handle,
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_network_get_service_state(telephony_h handle,
-       telephony_network_service_state_e *network_service_state);
+int telephony_network_get_service_state(telephony_h handle, telephony_network_service_state_e *network_service_state);
+
 
 /**
  * @brief Gets the current default subscription for data service (Packet Switched).
@@ -425,8 +425,8 @@ int telephony_network_get_service_state(telephony_h handle,
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_network_get_default_data_subscription(telephony_h handle,
-       telephony_network_default_data_subs_e *default_sub);
+int telephony_network_get_default_data_subscription(telephony_h handle, telephony_network_default_data_subs_e *default_sub);
+
 
 /**
  * @brief Gets the current default subscription for voice service (Circuit Switched).
@@ -448,8 +448,8 @@ int telephony_network_get_default_data_subscription(telephony_h handle,
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_network_get_default_subscription(telephony_h handle,
-       telephony_network_default_subs_e *default_sub);
+int telephony_network_get_default_subscription(telephony_h handle, telephony_network_default_subs_e *default_sub);
+
 
 /**
  * @brief Gets the network selection mode.
@@ -470,8 +470,8 @@ int telephony_network_get_default_subscription(telephony_h handle,
  * @retval #TELEPHONY_ERROR_NOT_SUPPORTED     Not supported
  * @retval #TELEPHONY_ERROR_OPERATION_FAILED  Operation failed
  */
-int telephony_network_get_selection_mode(telephony_h handle,
-       telephony_network_selection_mode_e *mode);
+int telephony_network_get_selection_mode(telephony_h handle, telephony_network_selection_mode_e *mode);
+
 
 /**
  * @brief Gets the TAC (Tracking Area Code) of the current location.
index bcb55384c3ff487cfe29e7a1343a3dc029881716..b247939e0962e0fddcf77ec5423d8ee1d3c4c194 100644 (file)
@@ -57,7 +57,7 @@ typedef enum {
 } telephony_sim_lock_state_e;
 
 /**
- * @brief Enumeration for the type of SIM card .
+ * @brief Enumeration for the type of SIM card.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum {
index 9d9c3de236088c83c6b1bed82fdc3e4525bca4f3..1b077162e8479bafc42aadfe90dd09b9ddc37c9b 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-telephony
 Summary:    Telephony Core API
-Version:    0.1.67
+Version:    0.1.68
 Release:    1
 Group:      System/Libraries
 License:    Apache-2.0