From: DoHyun Pyun Date: Wed, 8 Aug 2018 05:03:10 +0000 (+0900) Subject: Fix the API reference errors X-Git-Tag: submit/tizen/20180814.011534~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F03%2F186203%2F2;p=platform%2Fcore%2Fapi%2Fbluetooth.git Fix the API reference errors Change-Id: I19592d0e2e192760acaad618944af774c4530f5f Signed-off-by: DoHyun Pyun --- diff --git a/include/bluetooth.h b/include/bluetooth.h index bbaf80a..38ac6d0 100644 --- a/include/bluetooth.h +++ b/include/bluetooth.h @@ -148,11 +148,12 @@ int bt_adapter_get_address(char **local_address); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Gets the name of local Bluetooth adapter. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @details Use this function to get the friendly name associated with Bluetooth + * @details Use this function to get the friendly name associated with Bluetooth \n * device, retrieved by the remote Bluetooth devices. * + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * * @remarks The @a local_name must be released with free() by you. * * @param[out] local_name The local device name @@ -180,7 +181,7 @@ int bt_adapter_get_name(char **local_name); * @privilege %http://tizen.org/privilege/bluetooth * * @param[in] local_name The name of the Bluetooth device. \n - * The maximum length is 248 characters. + * The maximum length is 248 characters. * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -223,14 +224,14 @@ int bt_adapter_get_visibility(bt_adapter_visibility_mode_e *mode, int *duration) /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE * @brief Starts the device discovery, asynchronously. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif - * @privlevel public - * @privilege %http://tizen.org/privilege/bluetooth * - * @details If a device is discovered, bt_adapter_device_discovery_state_changed_cb() will be invoked - * with #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, and then bt_adapter_device_discovery_state_changed_cb() + * @details If a device is discovered, bt_adapter_device_discovery_state_changed_cb() will be invoked \n + * with #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, and then bt_adapter_device_discovery_state_changed_cb() \n * will be called with #BT_ADAPTER_DEVICE_DISCOVERY_FINISHED in case of the completion or cancellation of the discovery. * + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @privlevel public + * @privilege %http://tizen.org/privilege/bluetooth * @remarks To connect to peer Bluetooth device, you need to know its Bluetooth address. \n * The device discovery can be stopped by bt_adapter_stop_device_discovery(). * @@ -287,8 +288,8 @@ int bt_adapter_stop_device_discovery(void); * @brief Checks for the device discovery is in progress or not. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @remarks If Bluetooth discovery is in progress, other operations are not allowed and - * you have to either stop the discovery operation, or wait for it to be finished, + * @remarks If Bluetooth discovery is in progress, other operations are not allowed and \n + * you have to either stop the discovery operation, or wait for it to be finished, \n * before performing other operations. * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) @@ -310,7 +311,7 @@ int bt_adapter_is_discovering(bool *is_discovering); /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Get the service mask from the uuid list. + * @brief Gets the service mask from the UUID list. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @param[in] uuids The UUID list of the device. @@ -333,8 +334,8 @@ int bt_device_get_service_mask_from_uuid_list(char **uuids, * @brief Retrieves the device information of all bonded devices. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @param [in] callback The callback function to invoke - * @param [in] user_data The user data passed from the foreach function + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data passed from the foreach function * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -358,8 +359,8 @@ int bt_adapter_foreach_bonded_device(bt_adapter_bonded_device_cb callback, void * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks The @a device_info must be released with bt_adapter_free_device_info() by you . * - * @param [in] remote_address The address of remote device - * @param [out] device_info The bonded device information + * @param[in] remote_address The address of remote device + * @param[out] device_info The bonded device information * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -383,7 +384,7 @@ int bt_adapter_get_bonded_device_info(const char *remote_address, bt_device_info * @brief Frees device info. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @param [in] device_info The bonded device information + * @param[in] device_info The bonded device information * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -396,7 +397,7 @@ int bt_adapter_free_device_info(bt_device_info_s *device_info); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Checks whether the UUID of service is used or not + * @brief Checks whether the UUID of service is used or not. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] service_uuid The UUID of service * @param[out] used Indicates whether the service is used or not @@ -416,8 +417,8 @@ int bt_adapter_is_service_used(const char *service_uuid, bool *used); * @brief Registers a callback function to be invoked when the Bluetooth adapter state changes. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @param[in] callback The callback function to invoke - * @param[in] user_data The user data to be passed to the callback function + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data to be passed to the callback function * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -437,10 +438,10 @@ int bt_adapter_set_state_changed_cb(bt_adapter_state_changed_cb callback, void * /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Unregisters the callback function. + * @brief Unregisters the callback function. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @return 0 on success, otherwise a negative error value. + * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_SUPPORTED Not supported @@ -534,12 +535,14 @@ int bt_adapter_unset_visibility_mode_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_MODULE - * @brief Registers a callback function to be invoked every second + * @brief Registers a callback function to be invoked every second. + * + * @details When you set visibility mode as #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE, \n + * @a callback will be called every second until visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. + * * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * until the visibility mode is changed from #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE * to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. - * @details When you set visibility mode as #BT_ADAPTER_VISIBILITY_MODE_LIMITED_DISCOVERABLE, - * @a callback will be called every second until visibility mode is changed to #BT_ADAPTER_VISIBILITY_MODE_NON_DISCOVERABLE. * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function * @return 0 on success, otherwise a negative error value. @@ -614,7 +617,7 @@ int bt_adapter_unset_device_discovery_state_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_OOB_MODULE - * @brief Get the Hash and Randmoizer value, synchronously. + * @brief Gets the Hash and Randmoizer value, synchronously. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @param[out] hash The hash value received from the controller @@ -669,10 +672,8 @@ int bt_adapter_set_remote_oob_data(const char *remote_address, * @ingroup CAPI_NETWORK_BLUETOOTH_OOB_MODULE * @brief Gets the Hash and Randmoizer value, synchronously. * @since_tizen 3.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/bluetooth * - * @remarks The @a hash192, randomizer192, hash256 and randomizer256 must be released using free() + * @remarks The @a hash192, randomizer192, hash256 and randomizer256 must be released using free(). * * @param[out] hash192 The hash value derived from the P-192 public key * @param[out] randomizer192 The randomizer value associated with the P-192 public key @@ -764,8 +765,8 @@ int bt_adapter_remove_remote_oob_data(const char *remote_address); * @brief Checks for the LE device discovery is in progress or not. * @since_tizen 2.3 * - * @remarks If Bluetooth LE scan is in progress, other operations are not allowed and - * you have to either stop the LE scan operation, or wait for it to be finished, + * @remarks If Bluetooth LE scan is in progress, other operations are not allowed and \n + * you have to either stop the LE scan operation, or wait for it to be finished, \n * before performing other operations. * * @param[out] is_discovering The discovering status: (@c true = in progress , @c false = not in progress ) @@ -780,17 +781,17 @@ int bt_adapter_remove_remote_oob_data(const char *remote_address); * * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. */ -int bt_adapter_le_is_discovering(bool *is_discovering); +int bt_adapter_le_is_discovering(bool *is_discovering) TIZEN_DEPRECATED_API; /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE * @brief Starts the LE scan to find LE advertisement. - * @since_tizen 2.3.1 - * @privlevel public - * @privilege %http://tizen.org/privilege/bluetooth * * @details If a LE advertisement is found, bt_adapter_le_scan_result_cb() will be invoked. * + * @since_tizen 2.3.1 + * @privlevel public + * @privilege %http://tizen.org/privilege/bluetooth * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called * @@ -834,16 +835,16 @@ int bt_adapter_le_stop_scan(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service UUID list from the scan result information + * @brief Gets the service UUID list from the scan result information. * @since_tizen 2.3.1 * * @remarks The @a uuids must be iterated as count and each pointed data must be released with free(). - * Then uuids must be released with free(). \n + * Then @a uuids must be released with free(). \n * 16-bit service UUID or 128-bit service UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) * * @param[in] info The scan result information * @param[in] pkt_type The packet type - * @param[out] uuids The list of string of the service uuid + * @param[out] uuids The list of string of the service UUID * @param[out] count The count of the service UUIDs * * @return 0 on success, otherwise a negative error value. @@ -862,7 +863,7 @@ int bt_adapter_le_get_scan_result_service_uuids(const bt_adapter_le_device_scan_ /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the device name from the scan result information + * @brief Gets the device name from the scan result information. * @since_tizen 2.3.1 * * @remarks The @a name must be released with free() by you. @@ -887,7 +888,7 @@ int bt_adapter_le_get_scan_result_device_name(const bt_adapter_le_device_scan_re /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the transmission power level from the scan result information + * @brief Gets the transmission power level from the scan result information. * @since_tizen 2.3.1 * * @param[in] info The scan result information @@ -910,17 +911,17 @@ int bt_adapter_le_get_scan_result_tx_power_level(const bt_adapter_le_device_scan /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service solicitation UUID list from the scan result information + * @brief Gets the service solicitation UUID list from the scan result information. * @since_tizen 2.3.1 * * @remarks The @a uuids must be iterated as count and each pointed data must be released with free(). - * Then uuids must be released with free(). \n + * Then @a uuids must be released with free(). \n * 16-bit service solicitation UUID or 128-bit service solicitation UUID is supported. * (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) * * @param[in] info The scan result information * @param[in] pkt_type The packet type - * @param[out] uuids The list of string of the service solicitation uuid + * @param[out] uuids The list of string of the service solicitation UUID * @param[out] count The count of the service UUIDs * * @return 0 on success, otherwise a negative error value. @@ -939,7 +940,7 @@ int bt_adapter_le_get_scan_result_service_solicitation_uuids(const bt_adapter_le /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the service data list from the scan result information + * @brief Gets the service data list from the scan result information. * @since_tizen 2.3.1 * * @remarks The @a data_list must be released with bt_adapter_le_free_service_data_list() by you . @@ -982,7 +983,7 @@ int bt_adapter_le_free_service_data_list(bt_adapter_le_service_data_s *data_list /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the appearance from the scan result information + * @brief Gets the appearance from the scan result information. * @since_tizen 2.3.1 * * @param[in] info The scan result information @@ -1005,7 +1006,7 @@ int bt_adapter_le_get_scan_result_appearance(const bt_adapter_le_device_scan_res /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Gets the manufacturer data from the scan result information + * @brief Gets the manufacturer data from the scan result information. * @since_tizen 2.3.1 * * @remarks The @a manufacturer_data must be released with free() by you. @@ -1074,7 +1075,7 @@ int bt_adapter_le_free_ibeacon_report(bt_adapter_le_ibeacon_scan_result_info_s * /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Create advertiser to advertise device's existence or respond to LE scanning request. + * @brief Creates advertiser to advertise device's existence or respond to LE scanning request. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @param[out] advertiser The handle of advertiser @@ -1094,7 +1095,7 @@ int bt_adapter_le_create_advertiser(bt_advertiser_h *advertiser); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Destroy advertiser. + * @brief Destroys advertiser. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @param[out] advertiser The handle of advertiser @@ -1223,12 +1224,12 @@ int bt_ipsp_unset_connection_state_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add a service UUID to advertise or scan response data. + * @brief Adds a service UUID to advertise or scan response data. * The maximum advertised or responded data size is 31 bytes * including data type and system wide data. * @since_tizen 2.3.1 * - * @remarks 16-bit UUID or 128-bit UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB) + * @remarks 16-bit UUID or 128-bit UUID is supported. (e.g. 180F, 0000180F-0000-1000-8000-00805F9B34FB). * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type @@ -1251,7 +1252,7 @@ int bt_adapter_le_add_advertising_service_uuid(bt_advertiser_h advertiser, /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add a service solicitation UUID to advertise or scan response data. + * @brief Adds a service solicitation UUID to advertise or scan response data. * The maximum advertised or responded data size is 31 bytes * including data type and system wide data. * @since_tizen 2.3.1 @@ -1280,12 +1281,12 @@ int bt_adapter_le_add_advertising_service_solicitation_uuid(bt_advertiser_h adve /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add service data to advertise or scan response data. + * @brief Adds service data to advertise or scan response data. * The maximum advertised or responded data size is 31 bytes * including data type and system wide data. * @since_tizen 2.3.1 * - * @remarks 16-bit UUID is supported. (e.g. 180F) + * @remarks 16-bit UUID is supported. (e.g. 180F). * * @param[in] advertiser The handle of advertiser * @param[in] pkt_type The packet type @@ -1336,7 +1337,7 @@ int bt_adapter_le_set_advertising_appearance(bt_advertiser_h advertiser, /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Add manufacturer specific data to advertise or scan response data. + * @brief Adds manufacturer specific data to advertise or scan response data. * Please refer to the Bluetooth Assigned Numbers provided by the Bluetooth SIG for a list of existing company identifiers. * The maximum advertised or responded data size is 31 bytes * including data type and system wide data. @@ -1366,7 +1367,7 @@ int bt_adapter_le_add_advertising_manufacturer_data(bt_advertiser_h advertiser, /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the device name should be included in advertise or scan response data. + * @brief Sets whether the device name should be included in advertise or scan response data. * The maximum advertised or responded data size is 31 bytes * including data type and system wide data. * @since_tizen 2.3.1 @@ -1392,7 +1393,7 @@ int bt_adapter_le_set_advertising_device_name(bt_advertiser_h advertiser, /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the transmission power level should be included in advertise or scan response data. + * @brief Sets whether the transmission power level should be included in advertise or scan response data. * The maximum advertised or responded data size is 31 bytes * including data type and system wide data. * @since_tizen 2.3.1 @@ -1418,7 +1419,7 @@ int bt_adapter_le_set_advertising_tx_power_level(bt_advertiser_h advertiser, /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Clear all data to be advertised or responded to scan request from LE scanning device. + * @brief Clears all data to be advertised or responded to scan request from LE scanning device. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @param[in] advertiser The handle of advertiser @@ -1463,15 +1464,15 @@ int bt_adapter_le_stop_advertising(bt_advertiser_h advertiser); /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Start advertising with passed advertiser and advertising parameters. - * @since_tizen 2.3.1 - * @privlevel public - * @privilege %http://tizen.org/privilege/bluetooth + * @brief Starts advertising with passed advertiser and advertising parameters. * - * @details Once Bluetooth advertising is started, nearby Bluetooth LE(Low Energy) supported - * devices can know this device's existence. And one of them can make a connection request, + * @details Once Bluetooth advertising is started, nearby Bluetooth LE (Low Energy) supported \n + * devices can know this device's existence. And one of them can make a connection request, \n * if it is allowed. * + * @since_tizen 2.3.1 + * @privlevel public + * @privilege %http://tizen.org/privilege/bluetooth * @param[in] advertiser The handle of advertiser * @param[in] cb The callback to report the result of this function * @param[in] user_data The user data to be passed when callback is called @@ -1496,7 +1497,7 @@ int bt_adapter_le_start_advertising_new(bt_advertiser_h advertiser, bt_adapter_l /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set advertising mode to control the advertising power and latency. + * @brief Sets advertising mode to control the advertising power and latency. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -1521,7 +1522,7 @@ int bt_adapter_le_set_advertising_mode(bt_advertiser_h advertiser, bt_adapter_le /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Set whether the advertising type should be connectable or non-connectable + * @brief Sets whether the advertising type should be connectable or non-connectable. * @since_tizen 2.3.1 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -1546,7 +1547,7 @@ int bt_adapter_le_set_advertising_connectable(bt_advertiser_h advertiser, bool c /** * @ingroup CAPI_NETWORK_BLUETOOTH_ADAPTER_LE_MODULE - * @brief Sets Bluetooth LE scan mode + * @brief Sets Bluetooth LE scan mode. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -1606,7 +1607,7 @@ int bt_device_create_bond(const char *remote_address); * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * - * @remarks Use this function when the remote Bluetooth device is not responding to the + * @remarks Use this function when the remote Bluetooth device is not responding to the \n * bond request or you wish to cancel the bonding request. * * @return 0 on success, otherwise a negative error value. @@ -1724,9 +1725,9 @@ int bt_device_set_authorization(const char *remote_address, bt_device_authorizat * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * - * @remarks If creating a bond succeeds, which means bt_device_bond_created_cb() is called with result #BT_ERROR_NONE, + * @remarks If creating a bond succeeds, which means bt_device_bond_created_cb() is called with result #BT_ERROR_NONE, \n * then you don't need to run this function.\n - * The service search takes a couple of seconds to complete normally. \n + * The service search takes a couple of seconds to complete normally. * * @param[in] remote_address The address of the remote Bluetooth device whose services need to be checked * @@ -1797,7 +1798,7 @@ int bt_device_is_profile_connected(const char *remote_address, bt_profile_e bt_p /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Updates a LE connection mode + * @brief Updates a LE connection mode. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -1994,7 +1995,7 @@ int bt_device_unset_connection_state_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Registers a rfcomm server socket with a specific UUID. + * @brief Registers a RFCOMM server socket with a specific UUID. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -2022,11 +2023,11 @@ int bt_socket_create_rfcomm(const char *service_uuid, int *socket_fd); /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Removes the rfcomm server socket which was created using bt_socket_create_rfcomm(). + * @brief Removes the RFCOMM server socket which was created using bt_socket_create_rfcomm(). * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @remarks If callback function bt_socket_connection_state_changed_cb() is set and the remote Bluetooth device is connected, + * @remarks If callback function bt_socket_connection_state_changed_cb() is set and the remote Bluetooth device is connected, \n * then bt_socket_connection_state_changed_cb() will be called when this function is finished successfully. * * @param[in] socket_fd The file descriptor of socket (which was created using bt_socket_create_rfcomm()) to destroy @@ -2051,13 +2052,13 @@ int bt_socket_destroy_rfcomm(int socket_fd); /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Starts listening on passed rfcomm socket and accepts connection requests. + * @brief Starts listening on passed RFCOMM socket and accepts connection requests. + * @details Pop-up is shown automatically when a RFCOMM connection is requested. \n + * bt_socket_connection_state_changed_cb() will be called with \n + * #BT_SOCKET_CONNECTED if you click "yes" and connection is finished successfully. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details Pop-up is shown automatically when a RFCOMM connection is requested. - * bt_socket_connection_state_changed_cb() will be called with - * #BT_SOCKET_CONNECTED if you click "yes" and connection is finished successfully. * @param[in] socket_fd The file descriptor of socket on which start to listen * @param[in] max_pending_connections The maximum number of pending connections * @return 0 on success, otherwise a negative error value. @@ -2144,7 +2145,7 @@ int bt_socket_disconnect_rfcomm(int socket_fd); * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @remark The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. + * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section. * * @param[in] socket_fd The file descriptor of connected socket which was received using bt_socket_connection_state_changed_cb() * @param[in] data The data to be sent @@ -2154,6 +2155,7 @@ int bt_socket_disconnect_rfcomm(int socket_fd); * @retval On error, -1 is returned, and errno is set appropriately. See write 2 man page. * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @exception BT_ERROR_PERMISSION_DENIED Permission denied * @exception BT_ERROR_AGAIN Resource temporarily unavailable * @@ -2167,7 +2169,7 @@ int bt_socket_send_data(int socket_fd, const char *data, int length); /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when you receive data. + * @brief Registers a callback function that will be invoked when you receive data. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -2204,7 +2206,7 @@ int bt_socket_unset_data_received_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when a RFCOMM connection is requested. + * @brief Registers a callback function that will be invoked when a RFCOMM connection is requested. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -2239,7 +2241,7 @@ int bt_socket_unset_connection_requested_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_SOCKET_MODULE - * @brief Register a callback function that will be invoked when the connection state changes. + * @brief Registers a callback function that will be invoked when the connection state changes. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -2276,10 +2278,10 @@ int bt_socket_unset_connection_state_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Initializes the Bluetooth OPP server requested by bt_opp_server_connection_requested_cb(). - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif - * @details No popup appears when an OPP connection is requested from a remote device. - * Instead, @a connection_requested_cb() will be called. + * @details No popup appears when an OPP connection is requested from a remote device. \n + * Instead, @a connection_requested_cb() will be called. \n * At that time, you can call either bt_opp_server_accept() or bt_opp_server_reject(). + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks This function must be called to start Bluetooth OPP server. \n * You must free all resources of the Bluetooth service by calling bt_opp_server_deinitialize() if Bluetooth OPP service is no longer needed. * @param[in] destination The destination path @@ -2355,7 +2357,6 @@ int bt_opp_server_accept(bt_opp_server_transfer_progress_cb progress_cb, * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @retval #BT_ERROR_NOT_SUPPORTED Not supported @@ -2407,7 +2408,7 @@ int bt_opp_server_set_destination(const char *destination); * @brief Initializes the Bluetooth OPP client. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks This function must be called before Bluetooth OPP client starts. \n - * You must free all resources of the Bluetooth service by calling bt_opp_client_deinitialize() + * You must free all resources of the Bluetooth service by calling bt_opp_client_deinitialize() \n * if Bluetooth OPP service is no longer needed. * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -2444,8 +2445,8 @@ int bt_opp_client_deinitialize(void); * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * * @see bt_opp_client_clear_files() * @see bt_opp_client_push_files() @@ -2471,13 +2472,15 @@ int bt_opp_client_clear_files(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_CLIENT_MODULE * @brief Pushes the file to the remote device, asynchronously. + * + * @details At first, bt_opp_client_push_responded_cb() will be called when OPP server responds to the push request. \n + * After connection is established, bt_opp_client_push_progress_cb() will be called repeatedly until a file is transferred completely. \n + * If you send several files, then bt_opp_client_push_progress_cb() with another file will be called repeatedly until the file is transferred completely. \n + * bt_opp_client_push_finished_cb() will be called when the push request is finished. + * * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details At first, bt_opp_client_push_responded_cb() will be called when OPP server responds to the push request. - * After connection is established, bt_opp_client_push_progress_cb() will be called repeatedly until a file is transferred completely. - * If you send several files, then bt_opp_client_push_progress_cb() with another file will be called repeatedly until the file is transferred completely. - * bt_opp_client_push_finished_cb() will be called when the push request is finished. * @param[in] remote_address The remote address * @param[in] responded_cb The callback called when OPP server responds to the push request * @param[in] progress_cb The callback called when each file is being transferred @@ -2494,7 +2497,7 @@ int bt_opp_client_clear_files(void); * @retval #BT_ERROR_NOT_SUPPORTED Not supported * * @see bt_opp_client_initialize() - * @see bt_opp_client_cancel_push + * @see bt_opp_client_cancel_push() */ int bt_opp_client_push_files(const char *remote_address, bt_opp_client_push_responded_cb responded_cb, @@ -2526,10 +2529,10 @@ int bt_opp_client_cancel_push(void); /** * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif - * @brief Initializes the Bluetooth HID(Human Interface Device) Host. + * @brief Initializes the Bluetooth HID (Human Interface Device) Host. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks This function must be called before Bluetooth HID Host starts. \n - * You must free all resources of the Bluetooth service by calling bt_hid_host_deinitialize() + * You must free all resources of the Bluetooth service by calling bt_hid_host_deinitialize() \n * if Bluetooth HID Host service is no longer needed. * @param[in] connection_cb The callback called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function @@ -2548,7 +2551,7 @@ int bt_hid_host_initialize(bt_hid_host_connection_state_changed_cb connection_cb /** * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif - * @brief Deinitializes the Bluetooth HID(Human Interface Device) Host. + * @brief Deinitializes the Bluetooth HID (Human Interface Device) Host. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -2563,7 +2566,7 @@ int bt_hid_host_deinitialize(void); /** * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif - * @brief Connects the remote device with the HID(Human Interface Device) service, asynchronously. + * @brief Connects the remote device with the HID (Human Interface Device) service, asynchronously. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -2587,7 +2590,7 @@ int bt_hid_host_connect(const char *remote_address); /** * @ingroup @if WEARABLE CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE CAPI @else_NETWORK_BLUETOOTH_HID_MODULE @endif - * @brief Disconnects the remote device with the HID(Human Interface Device) service, asynchronously. + * @brief Disconnects the remote device with the HID (Human Interface Device) service, asynchronously. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -2616,7 +2619,7 @@ int bt_hid_host_disconnect(const char *remote_address); * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * - * @remarks This function must be called to register HID UUID. + * @remarks This function must be called to register HID UUID. \n * Only then a remote device is able to identify this one as a HID device. * * @param[in] callback The callback called when the connection state is changed @@ -2649,7 +2652,6 @@ int bt_hid_device_activate(bt_hid_device_connection_state_changed_cb callback, v * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_NOT_IN_PROGRESS Not activated * @retval #BT_ERROR_OPERATION_FAILED Operation failed @@ -2702,6 +2704,7 @@ int bt_hid_device_connect(const char *remote_address); * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_REMOTE_DEVICE_NOT_CONNECTED Remote device is not connected * @retval #BT_ERROR_OPERATION_FAILED Operation failed @@ -2767,6 +2770,7 @@ int bt_hid_device_send_key_event(const char *remote_address, * * @param[in] callback The callback function to be set when data is received. * @param[in] user_data The user data to be passed to the callback. + * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter @@ -2781,6 +2785,7 @@ int bt_hid_device_set_data_received_cb(bt_hid_device_data_received_cb callback, * @brief Unsets the data received callback. * @since_tizen @if WEARABLE 3.0 @endif * + * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_SUPPORTED Not supported @@ -2801,8 +2806,10 @@ int bt_hid_device_unset_data_received_cb(void); * @param[in] param_type The response parameter type * @param[in] data The response data * @param[in] data_len The length of the response data + * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_PERMISSION_DENIED Permission denied @@ -2821,7 +2828,7 @@ int bt_hid_device_reply_to_report(const char *remote_address, * @brief Initializes the Bluetooth profiles related with audio. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @remarks This function must be called before Bluetooth profiles related with audio starts. \n - * You must free all resources of the this service by calling bt_audio_deinitialize() + * You must free all resources of the this service by calling bt_audio_deinitialize() \n * if Bluetooth profiles related with audio service is no longer needed. * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -2853,11 +2860,12 @@ int bt_audio_deinitialize(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Connects the remote device with the given audio profile, asynchronously. + * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and connection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice \n + * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is connected and #BT_AUDIO_PROFILE_TYPE_A2DP is connected. + * * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and connection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice - * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is connected and #BT_AUDIO_PROFILE_TYPE_A2DP is connected. * @param[in] remote_address The remote address * @param[in] type The type of audio profile * @return 0 on success, otherwise a negative error value. @@ -2880,11 +2888,11 @@ int bt_audio_connect(const char *remote_address, bt_audio_profile_type_e type); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Disconnects the remote device with the given audio profile, asynchronously. + * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and disconnection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice \n + * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is disconnected and #BT_AUDIO_PROFILE_TYPE_A2DP is disconnected. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth - * @details If you input type as #BT_AUDIO_PROFILE_TYPE_ALL and disconnection request succeeds, then bt_audio_connection_state_changed_cb() will be called twice - * when #BT_AUDIO_PROFILE_TYPE_HSP_HFP is disconnected and #BT_AUDIO_PROFILE_TYPE_A2DP is disconnected. * @param[in] remote_address The remote address * @param[in] type The type of audio profile * @return 0 on success, otherwise a negative error value. @@ -2942,7 +2950,7 @@ int bt_audio_unset_connection_state_changed_cb(void); * @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) target service. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @remarks This function must be called before any other AVRCP target functions are called. \n - * You must free all resources of the this service by calling bt_avrcp_target_deinitialize() + * You must free all resources of the this service by calling bt_avrcp_target_deinitialize() \n * if Bluetooth AVRCP service is no longer needed. * @param[in] callback The callback function called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function @@ -3142,7 +3150,7 @@ int bt_avrcp_target_notify_track(const char *title, const char *artist, const ch /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3161,7 +3169,7 @@ int bt_avrcp_set_equalizer_state_changed_cb(bt_avrcp_equalizer_state_changed_cb /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the equalizer state is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3177,7 +3185,7 @@ int bt_avrcp_unset_equalizer_state_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3196,7 +3204,7 @@ int bt_avrcp_set_repeat_mode_changed_cb(bt_avrcp_repeat_mode_changed_cb callback /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the repeat mode is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3212,7 +3220,7 @@ int bt_avrcp_unset_repeat_mode_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3231,7 +3239,7 @@ int bt_avrcp_set_shuffle_mode_changed_cb(bt_avrcp_shuffle_mode_changed_cb callba /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the shuffle mode is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3247,7 +3255,7 @@ int bt_avrcp_unset_shuffle_mode_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3266,7 +3274,7 @@ int bt_avrcp_set_scan_mode_changed_cb(bt_avrcp_scan_mode_changed_cb callback, vo /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the scan mode is changed. (e.g., by a TV remote control or other input devices). * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3282,7 +3290,7 @@ int bt_avrcp_unset_scan_mode_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices). * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3301,7 +3309,7 @@ int bt_avrcp_set_position_changed_cb(bt_avrcp_position_changed_cb callback, void /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the song position is changed. (e.g., by a TV remote control or other input devices). * @since_tizen 3.0 * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3317,7 +3325,7 @@ int bt_avrcp_unset_position_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices). * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3336,7 +3344,7 @@ int bt_avrcp_set_play_status_changed_cb(bt_avrcp_play_status_changed_cb callback /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the Play status is changed. (e.g., by a TV remote control or other input devices). * @since_tizen 3.0 * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3352,7 +3360,7 @@ int bt_avrcp_unset_play_status_changed_cb(void); /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Registers a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices) + * @brief Registers a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices). * @since_tizen 3.0 * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -3371,7 +3379,7 @@ int bt_avrcp_set_track_info_changed_cb(bt_avrcp_track_info_changed_cb callback, /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Unregisters a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices) + * @brief Unregisters a callback function that will be invoked when the track metadata is changed. (e.g., by a TV remote control or other input devices). * @since_tizen 3.0 * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3390,7 +3398,7 @@ int bt_avrcp_unset_track_info_changed_cb(void); * @brief Initializes the Bluetooth AVRCP (Audio/Video Remote Control Profile) controller service. * @since_tizen 3.0 * @remarks This function must be called before any other AVRCP controller functions are called. \n - * You must free all resources of the this service by calling bt_avrcp_control_deinitialize() + * You must free all resources of the this service by calling bt_avrcp_control_deinitialize() \n * if Bluetooth AVRCP service is no longer needed. * @param[in] callback The callback function called when the connection state is changed * @param[in] user_data The user data to be passed to the callback function @@ -3429,7 +3437,9 @@ int bt_avrcp_control_deinitialize(void); * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() */ @@ -3445,7 +3455,9 @@ int bt_avrcp_control_connect(const char *remote_address); * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_SUPPORTED Not supported + * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @pre The Bluetooth audio service must be initialized with bt_avrcp_control_initialize(). * @see bt_avrcp_control_initialize() * @see bt_avrcp_control_connect() @@ -3690,7 +3702,7 @@ int bt_avrcp_control_get_play_status(bt_avrcp_player_state_e *status); * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_CONTROL_MODULE * @brief Gets the metadata of the track played by the remote device. * @since_tizen 3.0 - * @remarks The @a track must be released using bt_avrcp_control_free_track_info() + * @remarks The @a track must be released using bt_avrcp_control_free_track_info(). * @param[out] track The track metadata. * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -3725,7 +3737,7 @@ int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track) /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Registers an application that acts as the @a Sink role of HDP(Health Device Profile). + * @brief Registers an application that acts as the Sink role of HDP (Health Device Profile). * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -3736,6 +3748,7 @@ int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track) * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OUT_OF_MEMORY Out of memory * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_PERMISSION_DENIED Permission denied @@ -3748,7 +3761,7 @@ int bt_hdp_register_sink_app(unsigned short data_type, char **app_id); /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Unregisters the given application that acts as the @a Sink role of HDP(Health Device Profile). + * @brief Unregisters the given application that acts as the Sink role of HDP (Health Device Profile). * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -3756,6 +3769,7 @@ int bt_hdp_register_sink_app(unsigned short data_type, char **app_id); * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_PERMISSION_DENIED Permission denied @@ -3767,7 +3781,7 @@ int bt_hdp_unregister_sink_app(const char *app_id); /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Connects the remote device which acts as @a Source role, asynchronously. + * @brief Connects the remote device which acts as Source role, asynchronously. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -3994,7 +4008,7 @@ int bt_gatt_set_value(bt_gatt_h gatt_handle, const char *value, int value_length * * @remarks This function updates a value of @a gatt_handle locally. \n * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n + * in order to update the remote device's value. * * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type @a value will be saved in @a gatt_handle as this type @@ -4016,7 +4030,7 @@ int bt_gatt_set_int_value(bt_gatt_h gatt_handle, bt_data_type_int_e type, * * @remarks This function updates a value of @a gatt_handle locally. \n * When @a gatt_handle is associated with bt_gatt_client_h, bt_gatt_client_write_value() can be used after this function \n - * in order to update the remote device's value. \n + * in order to update the remote device's value. * * @param[in] gatt_handle The handle of a characteristic or descriptor * @param[in] type @a mantissa and @a exponent will be saved in @a gatt_handle as this type @@ -4038,7 +4052,7 @@ int bt_gatt_set_float_value(bt_gatt_h gatt_handle, bt_data_type_float_e type, * @since_tizen 2.3.1 * * @remarks @a uuid must be released using free(). \n - * 16-bit UUID or 128-bit UUID is supported. (e.g. 2A19, 00002A19-0000-1000-8000-00805F9B34FB) + * 16-bit UUID or 128-bit UUID is supported. (e.g. 2A19, 00002A19-0000-1000-8000-00805F9B34FB). * * @param[in] gatt_handle The handle of a service, characteristic or descriptor * @param[out] uuid The string of the UUID of @a gatt_handle @@ -4068,8 +4082,8 @@ int bt_gatt_get_type(bt_gatt_h gatt_handle, bt_gatt_type_e *gatt_type); * @brief Gets the GATT client handle which the specified service belongs to. * @since_tizen 2.3.1 * - * @remark This function doesn't allocate new memory for GATT client handle. - * The returned GATT client handle is the same one which was got from bt_gatt_client_create(). + * @remarks This function doesn't allocate new memory for GATT client handle. \n + * The returned GATT client handle is the same one which was got from bt_gatt_client_create(). \n * So if it is destroyed by bt_gatt_client_destroy(), all related GATT handles are freed also. * * @param[in] service The service's GATT handle @@ -4088,8 +4102,8 @@ int bt_gatt_service_get_client(bt_gatt_h service, bt_gatt_client_h *client); * @brief Gets a characteristic's GATT handle which has specific UUID. * @since_tizen 2.3.1 * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * @remarks The returned GATT handle must not be freed by application. \n + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). \n * If there are multiple characteristics which have same UUID, only the first matched one will be returned. * * @param[in] service The service's GATT handle @@ -4127,8 +4141,8 @@ int bt_gatt_service_foreach_characteristics(bt_gatt_h service, * @brief Gets an included service's GATT handle which has specific UUID. * @since_tizen 2.3.1 * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * @remarks The returned GATT handle must not be freed by application. \n + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). \n * If there are multiple included services which have same UUID, only the first matched one will be returned. * * @param[in] service The service's GATT handle @@ -4166,7 +4180,7 @@ int bt_gatt_service_foreach_included_services(bt_gatt_h service, * @brief Gets the service's GATT handle which the specified characteristic belongs to. * @since_tizen 2.3.1 * - * @remark The returned GATT handle must not be freed by application. + * @remarks The returned GATT handle must not be freed by application. \n * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). * * @param[in] characteristic The characteristic's GATT handle @@ -4234,8 +4248,8 @@ int bt_gatt_characteristic_set_write_type(bt_gatt_h characteristic, * @brief Gets a descriptor's GATT handle which has specific UUID. * @since_tizen 2.3.1 * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * @remarks The returned GATT handle must not be freed by application. \n + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). \n * If there are multiple descriptors which have same UUID, only the first matched one will be returned. * * @param[in] characteristic The characteristic's GATT handle @@ -4273,7 +4287,7 @@ int bt_gatt_characteristic_foreach_descriptors(bt_gatt_h characteristic, * @brief Gets the characteristic's GATT handle which the specified descriptor belongs to. * @since_tizen 2.3.1 * - * @remark The returned GATT handle must not be freed by application. + * @remarks The returned GATT handle must not be freed by application. \n * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). * * @param[in] descriptor The descriptor's GATT handle @@ -4290,7 +4304,7 @@ int bt_gatt_descriptor_get_characteristic(bt_gatt_h descriptor, bt_gatt_h *chara * @brief Creates the GATT client handle. * @since_tizen 2.3.1 * - * @remark The GATT client handle must be freed by bt_gatt_client_destroy() after use + * @remarks The GATT client handle must be freed by bt_gatt_client_destroy() after use. * * @param[in] remote_address The address of the remote device * @param[out] client The created GATT client's handle @@ -4310,7 +4324,7 @@ int bt_gatt_client_create(const char *remote_address, bt_gatt_client_h *client); * @brief Destroys the GATT client's handle. * @since_tizen 2.3.1 * - * @remark All related service, characteristic and descriptor's GATT handles are freed also + * @remarks All related service, characteristic and descriptor's GATT handles are freed also. * * @param[in] client The GATT client's handle * @return 0 on success, otherwise a negative error value @@ -4431,7 +4445,6 @@ int bt_gatt_client_request_att_mtu_change(bt_gatt_client_h client, unsigned int * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_ENABLED Not enabled * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @retval #BT_ERROR_NOT_SUPPORTED Not supported */ int bt_gatt_client_get_att_mtu(bt_gatt_client_h client, unsigned int *mtu); @@ -4465,6 +4478,7 @@ int bt_gatt_client_set_att_mtu_changed_cb(bt_gatt_client_h client, bt_gatt_clien * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized + * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_SUPPORTED Not supported * * @pre The Bluetooth service must be initialized with bt_initialize(). @@ -4516,8 +4530,8 @@ int bt_gatt_client_unset_characteristic_value_changed_cb(bt_gatt_h characteristi * @brief Gets a service's GATT handle which has specific UUID. * @since_tizen 2.3.1 * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). + * @remarks The returned GATT handle must not be freed by application. \n + * It will be freed when an associated client is destroyed by bt_gatt_client_destroy(). \n * If there are multiple services which have same UUID, only the first matched one will be returned. * * @param[in] client The GATT client's handle @@ -4570,7 +4584,7 @@ int bt_gatt_client_set_service_changed_cb(bt_gatt_client_h client, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_CLIENT_MODULE - * @brief Unregisters a callback function + * @brief Unregisters a callback function. * @since_tizen 3.0 * * @param[in] client The GATT client's handle @@ -4585,7 +4599,7 @@ int bt_gatt_client_unset_service_changed_cb(bt_gatt_client_h client); /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_CLIENT_MODULE - * @brief Connect to a specific LE based service on a remote bluetooth device address, asynchronously. + * @brief Connects to a specific LE based service on a remote bluetooth device address, asynchronously. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -4618,7 +4632,7 @@ int bt_gatt_connect(const char *address, bool auto_connect); /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_CLIENT_MODULE - * @brief Disconnect to LE connection with the given remote Bluetooth device address, asynchronously. + * @brief Disconnects to LE connection with the given remote Bluetooth device address, asynchronously. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth @@ -4653,6 +4667,7 @@ int bt_gatt_disconnect(const char *address); * @param[in] callback The callback function to register. * @param[in] user_data The user data to be passed to the callback function. * + * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter @@ -4669,6 +4684,7 @@ int bt_gatt_set_connection_state_changed_cb(bt_gatt_connection_state_changed_cb * @brief Unregisters a callback function that will be invoked when the connection state is changed. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * + * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_NOT_SUPPORTED Not supported @@ -4767,7 +4783,7 @@ int bt_gatt_descriptor_get_permissions(bt_gatt_h gatt_handle, int *permissions); * @brief Creates the GATT service. * @since_tizen 3.0 * - * @remarks The @a service should be destroyed by using bt_gatt_service_destroy() + * @remarks The @a service should be destroyed by using bt_gatt_service_destroy(). * * @param[in] uuid The UUID of the service * @param[in] type The type of the service @@ -4843,8 +4859,8 @@ int bt_gatt_service_get_server(bt_gatt_h service, bt_gatt_server_h *server); * @brief Creates the GATT characteristic. * @since_tizen 3.0 * - * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. - * @remarks The @a properties can be one or more values of #bt_gatt_property_e, combined with bitwise 'or'. + * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. \n + * @remarks The @a properties can be one or more values of #bt_gatt_property_e, combined with bitwise 'or'. \n * @remarks The @a characteristic should be destroyed by using bt_gatt_characteristic_destroy(). * * @param[in] uuid The UUID of the characteristic @@ -4888,7 +4904,7 @@ int bt_gatt_characteristic_add_descriptor(bt_gatt_h characteristic, * @brief Creates the GATT characteristic descriptor. * @since_tizen 3.0 * - * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. + * @remarks The @a permissions can be one or more values of #bt_gatt_permission_e, combined with bitwise 'or'. \n * @remarks The @a descriptor should be destroyed by using bt_gatt_descriptor_destroy(). * * @param[in] uuid The UUID of the descriptor @@ -4917,7 +4933,6 @@ int bt_gatt_descriptor_create(const char *uuid, int permissions, * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @retval #BT_ERROR_NOT_SUPPORTED Not supported * * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. @@ -4934,7 +4949,6 @@ int bt_gatt_server_initialize(void); * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized * @retval #BT_ERROR_OPERATION_FAILED Operation failed - * @retval #BT_ERROR_PERMISSION_DENIED Permission denied * @retval #BT_ERROR_NOT_SUPPORTED Not supported * * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED. @@ -4947,7 +4961,7 @@ int bt_gatt_server_deinitialize(void); * @brief Creates the GATT server's handle. * @since_tizen 3.0 * - * @remarks The @a server handle should be destroyed by using bt_gatt_server_destroy() + * @remarks The @a server handle should be destroyed by using bt_gatt_server_destroy(). * * @param[out] server The GATT server's handle * @return 0 on success, otherwise a negative error value @@ -4965,7 +4979,7 @@ int bt_gatt_server_create(bt_gatt_server_h *server); * @brief Destroys the GATT server's handle. * @since_tizen 3.0 * - * @remarks All registered services to GATT server are unregistered + * @remarks All registered services to GATT server are unregistered. * * @param[in] server The GATT server's handle * @return 0 on success, otherwise a negative error value @@ -5106,7 +5120,6 @@ int bt_gatt_server_unregister_all_services(bt_gatt_server_h server); * * @return 0 on success, otherwise a negative error value * @retval #BT_ERROR_NONE Successful - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_OPERATION_FAILED Operation failed * @retval #BT_ERROR_ALREADY_DONE Operation is already done * @retval #BT_ERROR_PERMISSION_DENIED Permission denied @@ -5170,8 +5183,8 @@ int bt_gatt_server_notify_characteristic_changed_value(bt_gatt_h characteristic, * @brief Gets a service's GATT handle which has specific UUID. * @since_tizen 3.0 * - * @remark The returned GATT handle must not be freed by application. - * It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). + * @remarks The returned GATT handle must not be freed by application. \n + * It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). \n * If there are multiple services which have same UUID, only the first matched one will be returned. * * @param[in] server The GATT server's handle @@ -5212,7 +5225,7 @@ int bt_gatt_server_foreach_services(bt_gatt_server_h server, * @details This initialization is necessary to call other PBAP client APIs. * @since_tizen 3.0 * - * @remarks This function must be called to initialize Bluetooth PBAP client. You must free all resources of the Bluetooth service + * @remarks This function must be called to initialize Bluetooth PBAP client. You must free all resources of the Bluetooth service \n * by calling bt_pbap_client_deinitialize() if Bluetooth PBAP Client is no longer needed. * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -5287,7 +5300,6 @@ int bt_pbap_client_set_connection_state_changed_cb(bt_pbap_connection_state_chan * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful * @retval #BT_ERROR_NOT_INITIALIZED Not initialized - * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #BT_ERROR_NOT_SUPPORTED Not supported * * @pre The PBAP client must be initialized with bt_pbap_client_initialize(). @@ -5901,7 +5913,7 @@ int bt_adapter_le_scan_filter_set_type(bt_scan_filter_h scan_filter, * @privlevel public * @privilege %http://tizen.org/privilege/bluetooth * - * @remarks Several scan filters can be registered. If an advertisement passes + * @remarks Several scan filters can be registered. If an advertisement passes \n * any of the registered scan filters, it will be included in the results. * * @param[in] scan_filter The scan filter handle diff --git a/include/bluetooth_internal.h b/include/bluetooth_internal.h index 50d7277..5b1383c 100644 --- a/include/bluetooth_internal.h +++ b/include/bluetooth_internal.h @@ -791,8 +791,8 @@ int bt_adapter_le_set_advertising_filter_policy(bt_advertiser_h advertiser, bt_a * @since_tizen 4.0 * * @param[in] profile_uuid The UUID of profile service uuid of the connected device - * @param [in] callback The callback function to invoke - * @param [in] user_data The user data passed from the foreach function + * @param[in] callback The callback function to invoke + * @param[in] user_data The user data passed from the foreach function * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -975,7 +975,7 @@ int bt_device_set_profile_trusted(const char *device_address, bt_trusted_profile /** * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE - * @brief Get a profile is trusted or untrusted for a device. + * @brief Gets a profile is trusted or untrusted for a device. * @since_tizen 4.0 * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful @@ -2442,8 +2442,8 @@ int bt_device_le_conn_update(const char *device_address, * @brief Gets the is_alias_set property of a bonded device. * @since_tizen 3.0 * - * @param [in] remote_address The address of remote device - * @param [out] is_alias_set The is_alias_set property of device + * @param[in] remote_address The address of remote device + * @param[out] is_alias_set The is_alias_set property of device * * @return 0 on success, otherwise a negative error value. * @retval #BT_ERROR_NONE Successful diff --git a/include/bluetooth_type.h b/include/bluetooth_type.h index 453b5f0..bb3e936 100644 --- a/include/bluetooth_type.h +++ b/include/bluetooth_type.h @@ -468,7 +468,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE - * @brief Enumerations for the types of profiles related with audio + * @brief Enumerations for the types of profiles related with audio. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { @@ -481,7 +481,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE - * @brief Enumerations for the call handling event + * @brief Enumerations for the call handling event. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { @@ -492,7 +492,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE - * @brief Enumerations for the multi call handling event + * @brief Enumerations for the multi call handling event. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { @@ -505,7 +505,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Enumerations for the equalizer state + * @brief Enumerations for the equalizer state. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif */ typedef enum { @@ -515,7 +515,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Enumerations for the repeat mode + * @brief Enumerations for the repeat mode. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif */ typedef enum { @@ -527,7 +527,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Enumerations for the shuffle mode + * @brief Enumerations for the shuffle mode. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif */ typedef enum { @@ -538,7 +538,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Enumerations for the scan mode + * @brief Enumerations for the scan mode. * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif */ typedef enum { @@ -549,7 +549,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Enumerations for the player state + * @brief Enumerations for the player state. * @since_tizen 3.0 */ typedef enum { @@ -562,7 +562,7 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE - * @brief Enumeration for the player control commands + * @brief Enumeration for the player control commands. * @since_tizen 3.0 */ typedef enum { @@ -596,7 +596,7 @@ typedef struct { * @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE * @brief Called when the connection state is changed. * @since_tizen 3.0 - * @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false. + * @param[in] connected The state to be changed. true means connected state, Otherwise, false. * @param[in] remote_address The remote address * @param[in] user_data The user data passed from the callback registration function * @see bt_avrcp_control_initialize() @@ -639,7 +639,7 @@ typedef void (*bt_avrcp_play_status_changed_cb) (bt_avrcp_player_state_e play_st /** * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE - * @brief Enumerations for the data channel type + * @brief Enumerations for the data channel type. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { @@ -688,8 +688,8 @@ typedef enum { */ typedef enum { BT_GATT_TYPE_SERVICE = 0x01, /**< GATT service type */ - BT_GATT_TYPE_CHARACTERISTIC = 0x02, /** GATT characteristic type */ - BT_GATT_TYPE_DESCRIPTOR = 0x03, /** GATT descriptor type */ + BT_GATT_TYPE_CHARACTERISTIC = 0x02, /**< GATT characteristic type */ + BT_GATT_TYPE_DESCRIPTOR = 0x03, /**< GATT descriptor type */ } bt_gatt_type_e; /** @@ -744,17 +744,17 @@ typedef enum { /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE - * @brief Enumerations of the remote device request types for attributes + * @brief Enumerations of the remote device request types for attributes. * @since_tizen 3.0 */ typedef enum { - BT_GATT_REQUEST_TYPE_READ = 0x00, /* Read Requested */ - BT_GATT_REQUEST_TYPE_WRITE = 0x01, /* Write Requested */ + BT_GATT_REQUEST_TYPE_READ = 0x00, /**< Read Requested */ + BT_GATT_REQUEST_TYPE_WRITE = 0x01, /**< Write Requested */ } bt_gatt_att_request_type_e; /** * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE - * @brief Enumerations for the types of PAN(Personal Area Networking) service. + * @brief Enumerations for the types of PAN (Personal Area Networking) service. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif */ typedef enum { @@ -992,11 +992,11 @@ typedef struct { /** * @ingroup CAPI_NETWORK_BLUETOOTH_DEVICE_MODULE * @brief Service Discovery Protocol (SDP) data structure. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @details This protocol is used for discovering available services or pear device, * and finding one to connect with. * + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @see bt_device_service_searched_cb() */ typedef struct { @@ -1038,7 +1038,7 @@ typedef struct { * @brief Structure of RFCOMM received data. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @remarks User can use standard linux functions for reading/writing + * @remarks User can use standard linux functions for reading/writing \n * data from/to sockets. * * @see bt_socket_data_received_cb() @@ -1114,7 +1114,7 @@ typedef void (*bt_adapter_visibility_duration_changed_cb)(int duration, void *us * @brief Called when the state of device discovery changes. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @remarks If \a discovery_state is #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, + * @remarks If \a discovery_state is #BT_ADAPTER_DEVICE_DISCOVERY_FOUND, \n * then you can get some information, such as remote device address, remote device name, rssi, and bonding state. * * @param[in] result The result of the device discovery @@ -1188,10 +1188,10 @@ typedef void (*bt_adapter_le_advertising_state_changed_cb)(int result, * @brief Called when the process of creating bond finishes. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @remarks If the remote user does not respond within 60 seconds, a time out will happen with #BT_ERROR_TIMED_OUT result code.\n - * If bt_device_cancel_bonding() is called and it returns #BT_ERROR_NONE, then this callback function will be called + * @remarks If the remote user does not respond within 60 seconds, a time out will happen with #BT_ERROR_TIMED_OUT result code. \n + * If bt_device_cancel_bonding() is called and it returns #BT_ERROR_NONE, then this callback function will be called \n * with #BT_ERROR_CANCELLED result. \n - * If creating a bond succeeds but service search fails, then this callback will be called with #BT_ERROR_SERVICE_SEARCH_FAILED. + * If creating a bond succeeds but service search fails, then this callback will be called with #BT_ERROR_SERVICE_SEARCH_FAILED. \n * In this case, you should try service search again by bt_device_start_service_search() to get the supported service list. * * @param[in] result The result of the bonding device @@ -1261,8 +1261,6 @@ typedef void (*bt_device_authorization_changed_cb) * @brief Called when the process of service search finishes. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @remark - * * @param[in] result The result of the service searching * @param[in] sdp_info The structure of service lists found on a device * @param[in] user_data The user data passed from the callback registration function @@ -1341,10 +1339,10 @@ typedef void (*bt_socket_connection_requested_cb) (int socket_fd, const char *re /** * @ingroup CAPI_NETWORK_BLUETOOTH_OPP_SERVER_MODULE * @brief Called when an OPP connection is requested. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @details You must call bt_opp_server_accept_connection() if you want to accept. * Otherwise, you must call bt_opp_server_reject_connection(). + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] remote_address The address of remote device * @param[in] user_data The user data passed from the callback registration function * @see bt_opp_server_accept() @@ -1371,7 +1369,7 @@ typedef void (*bt_opp_server_transfer_progress_cb) (const char *file, long long * @brief Called when a transfer is finished. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @param[in] error_code The result of push + * @param[in] result The result of push * @param[in] file The path of file to be pushed * @param[in] size The file size (bytes) * @param[in] user_data The user data passed from the callback registration function @@ -1422,12 +1420,12 @@ typedef void (*bt_opp_client_push_finished_cb)(int result, const char *remote_ad /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_MODULE * @brief Called when the connection state is changed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @details This callback is called when the connection state is changed. + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * When you call bt_audio_connect() or bt_audio_disconnect(), this callback is also called with error result even though these functions fail. * @param[in] result The result of changing the connection state - * @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false. + * @param[in] connected The state to be changed. true means connected state, Otherwise, false. * @param[in] remote_address The remote address * @param[in] type The type of audio profile except #BT_AUDIO_PROFILE_TYPE_ALL * @param[in] user_data The user data passed from the callback registration function @@ -1463,7 +1461,7 @@ typedef void (*bt_ag_multi_call_handling_event_cb) (bt_ag_multi_call_handling_ev /** * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE - * @brief Called when a DTMF(Dual Tone Multi Frequency) is transmitted from Hands-Free. + * @brief Called when a DTMF (Dual Tone Multi Frequency) is transmitted from Hands-Free. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @param[in] dtmf The DTMF transmitted from Hands-Free @@ -1502,7 +1500,7 @@ typedef void (*bt_ag_microphone_gain_changed_cb) (int gain, void *user_data); * @brief Called when the connection state is changed. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false. + * @param[in] connected The state to be changed. true means connected state, Otherwise, false. * @param[in] remote_address The remote address * @param[in] user_data The user data passed from the callback registration function * @see bt_avrcp_target_initialize() @@ -1551,7 +1549,7 @@ typedef void (*bt_avrcp_shuffle_mode_changed_cb) (bt_avrcp_shuffle_mode_e shuffl * @brief Called when the scan mode is changed by the remote control device. * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * - * @param[in] shuffle The shuffle mode + * @param[in] scan The scan mode * @param[in] user_data The user data passed from the callback registration function * @see bt_avrcp_set_scan_mode_changed_cb() * @see bt_avrcp_unset_scan_mode_changed_cb() @@ -1561,12 +1559,12 @@ typedef void (*bt_avrcp_scan_mode_changed_cb) (bt_avrcp_scan_mode_e scan, void * /** * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * @brief Called when the connection state is changed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @details This callback is called when the connection state is changed. * When you call bt_hid_host_connect() or bt_hid_host_disconnect(), this callback is also called with error result even though these functions fail. + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] result The result of changing the connection state - * @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false. + * @param[in] connected The state to be changed. true means connected state, Otherwise, false. * @param[in] remote_address The remote address * @param[in] user_data The user data passed from the callback registration function * @see bt_hid_host_connect() @@ -1582,10 +1580,9 @@ typedef void (*bt_hid_host_connection_state_changed_cb) (int result, bool connec * @param[in] result The result of connecting to the remote device * @param[in] remote_address The address of connected remote device * @param[in] app_id The ID of application - * @param[in] type The type of HDP(Health Device Profile) channel + * @param[in] type The type of HDP (Health Device Profile) channel * @param[in] channel The connected data channel * @param[in] user_data The user data passed from the callback registration function - * @see bt_hdp_disconnected_cb * @see bt_hdp_set_connection_state_changed_cb() * @see bt_hdp_unset_connection_state_changed_cb() */ @@ -1601,7 +1598,6 @@ typedef void (*bt_hdp_connected_cb) (int result, const char *remote_address, con * @param[in] remote_address The address of disconnected remote device * @param[in] channel The connected data channel * @param[in] user_data The user data passed from the callback registration function - * @see bt_hdp_connected_cb * @see bt_hdp_set_connection_state_changed_cb() * @see bt_hdp_unset_connection_state_changed_cb() */ @@ -1623,7 +1619,7 @@ typedef void (*bt_hdp_data_received_cb) (unsigned int channel, const char *data, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE - * @brief Called when you get GATT handles repeatedly + * @brief Called when you get GATT handles repeatedly. * @since_tizen 2.3.1 * * @param[in] total The total number of GATT handles to be called @@ -1657,8 +1653,8 @@ typedef struct { * @brief Called when the ATT MTU value is changed. * @since_tizen 4.0 * - * @remarks The @a mtu_info must not be freed by application. - * @a mtu_info can be used only inside the callback. + * @remarks The @a mtu_info must not be freed by application. \n + * @a mtu_info can be used only inside the callback. \n * If it's needed outside, make a copy. * * @param[in] client The handle of a GATT client which is associated with a remote device @@ -1673,7 +1669,7 @@ typedef void (*bt_gatt_client_att_mtu_changed_cb)(bt_gatt_client_h client, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_CLIENT_MODULE - * @brief Called when the client request(e.g. read / write) has been completed + * @brief Called when the client request(e.g. read / write) has been completed. * @since_tizen 2.3.1 * * @param[in] result The result of a request @@ -1688,10 +1684,10 @@ typedef void (*bt_gatt_client_request_completed_cb) (int result, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_CLIENT_MODULE - * @brief Called when a value of a watched characteristic's GATT handle has been changed + * @brief Called when a value of a watched characteristic's GATT handle has been changed. * @since_tizen 2.3.1 * - * @remarks After this function is returned, a changed value is automatically + * @remarks After this function is returned, a changed value is automatically \n * applied to @a characteristic. Before that, @a characteristic has an old value. * * @param[in] characteristic The characteristic's GATT handle of which value change is informed. It has an old value. @@ -1723,13 +1719,13 @@ typedef void (*bt_gatt_client_service_changed_cb) (bt_gatt_client_h client, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE * @brief Called when the connection state is changed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @details This callback is called when the connection state is changed. * When you called bt_gatt_connect() or bt_gatt_disconnect(), this callback is also called with error result even though these functions fail. * + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] result The result of changing the connection state. - * @param[in] connected The state to be changed, @a true means connected state, Otherwise, @a false. + * @param[in] connected The state to be changed, true means connected state, Otherwise, false. * @param[in] remote_address The remote_address * @param[in] user_data The user data passed from the callback registration function. * @@ -1743,11 +1739,11 @@ typedef void (*bt_gatt_connection_state_changed_cb)(int result, bool connected, /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Called when a value of a characteristic or descriptor's GATT handle has been changed. - * @since_tizen 3.0 * * @details For finishing the request, call the function #bt_gatt_server_send_response in callback. * - * @remarks After this function is returned, a changed value is automatically + * @since_tizen 3.0 + * @remarks After this function is returned, a changed value is automatically \n * applied to @a gatt_handle. Before that, @a gatt_handle has an old value. * @remarks The @a remote_address must not be freed by application. * @remarks The @a server must not be freed by application. @@ -1775,10 +1771,10 @@ typedef void (*bt_gatt_server_write_value_requested_cb) (const char *remote_addr /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Called when the remote device requests to read a value on a GATT server. - * @since_tizen 3.0 * * @details For finishing the request, call the function #bt_gatt_server_send_response in callback. * + * @since_tizen 3.0 * @remarks The @a remote_address must not be freed by application. * @remarks The @a server must not be freed by application. * @remarks The @a gatt_handle must not be freed by application. @@ -1800,10 +1796,10 @@ typedef void (*bt_gatt_server_read_value_requested_cb) (const char *remote_addre /** * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_SERVER_MODULE * @brief Called when the remote device enables or disables the Notification/Indication for particular characteristics. - * @since_tizen 3.0 * * @details By using this callback function, server can know notification state. * + * @since_tizen 3.0 * @remarks The @a server must not be freed by application. * @remarks The @a gatt_handle must not be freed by application. * @@ -1860,12 +1856,12 @@ typedef void (*bt_nap_connection_state_changed_cb) (bool connected, const char * /** * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE * @brief Called when the connection state is changed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * * @details This callback is called when the connection state is changed. * When you call bt_panu_connect() or bt_panu_disconnect(), this callback is also called with error result even though these functions fail. + * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif * @param[in] result The result of changing the connection state - * @param[in] connected The state to be changed. @a true means connected state, Otherwise, @a false. + * @param[in] connected The state to be changed. true means connected state, Otherwise, false. * @param[in] remote_address The remote address * @param[in] type The type of PAN service * @param[in] user_data The user data passed from the callback registration function @@ -1903,8 +1899,8 @@ typedef struct { /** * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE * @brief The structure type containing the HID keyboard event information. - * @since_tizen @if WEARABLE 3.0 @endif * @details If you want to know more detail values, refer to http://www.usb.org/developers/hidpage/ and see "HID Usage Tables" + * @since_tizen @if WEARABLE 3.0 @endif * * @see bt_hid_device_send_key_event() */ @@ -1976,7 +1972,7 @@ typedef struct { * @since_tizen @if WEARABLE 3.0 @endif * * @param[in] result The result of changing the connection state. - * @param[in] connected The requested state. @a true means the connection is enabled, @a false means the connection is disabled. + * @param[in] connected The requested state. true means the connection is enabled, false means the connection is disabled. * @param[in] remote_address The remote device's address * @param[in] user_data The user data passed from the callback registration function * @see bt_hid_device_activate() @@ -2065,7 +2061,6 @@ typedef void (*bt_pbap_phone_book_size_cb)(int result, const char *remote_addres * @param[in] result The result of getting the phone book * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.) * @param[in] vcf_file The absolute path of the file in which the vCards are saved (@a vcf_file is valid only inside this function. To use outside the callback, make a copy. @a vcf_file should not be freed.) - * @param[in] successful true if the operation was successful, false if not * @param[in] user_data The user data passed from the callback registration function * @see bt_pbap_client_get_phone_book() * @see bt_pbap_client_connect() @@ -2087,7 +2082,6 @@ typedef void (*bt_pbap_phone_book_received_cb)(int result, const char *remote_ad * @param[in] remote_address The remote device address (@a remote_address is valid only inside this function. To use outside the callback, make a copy. @a remote_address should not be freed.) * @param[in] vcard_info List of vcard information (@a vcard_info is valid only inside this function. To use outside the callback, make a copy. @a vcard_info should not be freed.) * @param[in] count Number of contacts in the list - * @param[in] successful true if the operation was successful, false if not * @param[in] user_data The user data passed from the callback registration function * @see bt_pbap_client_get_list() * @see bt_pbap_client_connect()