/**
* @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
* @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
/**
* @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().
*
* @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 )
/**
* @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.
* @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
* @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
* @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
/**
* @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
* @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
/**
* @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
/**
* @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.
/**
* @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
* @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
* @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 )
*
* @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
*
/**
* @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.
/**
* @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.
/**
* @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
/**
* @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.
/**
* @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 .
/**
* @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
/**
* @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.
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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.
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
* @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.
* @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
*
/**
* @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
/**
* @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
/**
* @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
/**
* @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.
* @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
* @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
*
/**
* @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
/**
* @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
/**
* @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
/**
* @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
* @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
* @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
* @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()
/**
* @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
* @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,
/**
* @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
/**
* @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
/**
* @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
/**
* @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
* @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
* @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
* @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
*
* @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
* @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
* @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
* @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
/**
* @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.
/**
* @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.
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
/**
* @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
* @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
* @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()
*/
* @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()
* @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
/**
* @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
* @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
/**
* @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
* @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
/**
* @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
*
* @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
*
* @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
* @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
* @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
* @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
* @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
* @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
* @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
* @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
* @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
* @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
* @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);
* @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().
* @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
/**
* @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
/**
* @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
/**
* @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
* @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
* @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
* @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
* @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
* @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
* @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.
* @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.
* @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
* @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
*
* @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
* @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
* @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
* @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().
* @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
/**
* @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 {
/**
* @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 {
/**
* @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 {
/**
* @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 {
/**
* @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 {
/**
* @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 {
/**
* @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 {
/**
* @ingroup CAPI_NETWORK_BLUETOOTH_AVRCP_MODULE
- * @brief Enumerations for the player state
+ * @brief Enumerations for the player state.
* @since_tizen 3.0
*/
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 {
* @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()
/**
* @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 {
*/
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;
/**
/**
* @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 {
/**
* @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 {
* @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()
* @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
* @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
* @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
/**
* @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()
* @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
/**
* @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
/**
* @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
* @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()
* @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()
/**
* @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()
* @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()
*/
* @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()
*/
/**
* @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
* @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
/**
* @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
/**
* @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.
/**
* @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.
*
/**
* @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.
/**
* @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.
/**
* @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.
*
/**
* @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
/**
* @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()
*/
* @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()
* @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()
* @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()
projects / platform / core / api / bluetooth.git / commitdiff