Fix api doxygen for hid device

Change-Id: Ie285c9ddf5f41d41c81fe460b0298b89c4fc01b2

diff --git a/include/bluetooth.h b/include/bluetooth.h
index 97cee36..f562622 100644 (file)
--- a/include/bluetooth.h
+++ b/include/bluetooth.h
@@ -2747,7 +2747,9 @@ int bt_hid_device_disconnect(const char *remote_address);
  *
  * @param[in] remote_address The remote device's address.
  * @param[in] mouse_data The mouse data to be passed to the remote device.
- * @return 0 on success, otherwise a negative error value.
+ *
+ * @return the number of bytes written (zero indicates nothing was written).
+ * @retval On error, -1 is returned, and errno is set appropriately. See write 2 man page.
  * @retval #BT_ERROR_NONE  Successful
  * @retval #BT_ERROR_NOT_INITIALIZED  Not initialized
  * @retval #BT_ERROR_INVALID_PARAMETER  Invalid parameter
@@ -2771,7 +2773,9 @@ int bt_hid_device_send_mouse_event(const char *remote_address,
  *
  * @param[in] remote_address The remote device's address.
  * @param[in] key_data The key data to be passed to the remote device
- * @return 0 on success, otherwise a negative error value.
+ *
+ * @return the number of bytes written (zero indicates nothing was written).
+ * @retval On error, -1 is returned, and errno is set appropriately. See write 2 man page.
  * @retval #BT_ERROR_NONE  Successful
  * @retval #BT_ERROR_NOT_INITIALIZED  Not initialized
  * @retval #BT_ERROR_INVALID_PARAMETER  Invalid parameter
@@ -2831,7 +2835,9 @@ 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.
+ *
+ * @return the number of bytes written (zero indicates nothing was written).
+ * @retval On error, -1 is returned, and errno is set appropriately. See write 2 man page.
  * @retval #BT_ERROR_NONE  Successful
  * @retval #BT_ERROR_NOT_INITIALIZED  Not initialized
  * @retval #BT_ERROR_INVALID_PARAMETER  Invalid parameter