You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ja...@apache.org on 2024/05/16 12:48:50 UTC
(mynewt-nimble) 04/04: Update GATT function descriptions
This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git
commit 9190dcc9e9cbf1b099213ccac447aeb7ff3d8474
Author: Szymon Czapracki <sz...@codecoup.pl>
AuthorDate: Wed May 15 14:56:50 2024 +0200
Update GATT function descriptions
This commit modifies GATT functions description
to get them up to speed with current doxygen rules.
---
nimble/host/include/host/ble_gatt.h | 45 ++++++++++++++++++++++++++++++++-----
1 file changed, 40 insertions(+), 5 deletions(-)
diff --git a/nimble/host/include/host/ble_gatt.h b/nimble/host/include/host/ble_gatt.h
index 2532e4d2..5a268c0c 100644
--- a/nimble/host/include/host/ble_gatt.h
+++ b/nimble/host/include/host/ble_gatt.h
@@ -334,6 +334,8 @@ int ble_gattc_exchange_mtu(uint16_t conn_handle,
* updates; null for no callback.
* @param cb_arg The optional argument to pass to the callback
* function.
+ *
+ * @return 0 on success; nonzero on failure.
*/
int ble_gattc_disc_all_svcs(uint16_t conn_handle,
ble_gatt_disc_svc_fn *cb, void *cb_arg);
@@ -637,6 +639,8 @@ int ble_gattc_write_long(uint16_t conn_handle, uint16_t attr_handle,
* updates; null for no callback.
* @param cb_arg The optional argument to pass to the callback
* function.
+ *
+ * @return 0 on success; nonzero on failure.
*/
int ble_gattc_write_reliable(uint16_t conn_handle,
struct ble_gatt_attr *attrs,
@@ -686,7 +690,15 @@ int ble_gatts_notify_multiple_custom(uint16_t conn_handle,
struct ble_gatt_notif *tuples);
/**
- * Deprecated. Should not be used. Use ble_gatts_notify_custom instead.
+ * @deprecated Should not be used. Use ble_gatts_notify_custom instead.
+ *
+ * @param conn_handle The connection over which to execute the
+ * procedure.
+ * @param att_handle The attribute handle to indicate in the
+ * outgoing notification.
+ * @param om The value to write to the characteristic.
+ *
+ * @return 0 on success; nonzero on failure.
*/
int ble_gattc_notify_custom(uint16_t conn_handle, uint16_t att_handle,
struct os_mbuf *om);
@@ -706,7 +718,15 @@ int ble_gattc_notify_custom(uint16_t conn_handle, uint16_t att_handle,
int ble_gatts_notify(uint16_t conn_handle, uint16_t chr_val_handle);
/**
- * Deprecated. Should not be used. Use ble_gatts_notify instead.
+ * @deprecated Should not be used. Use ble_gatts_notify instead.
+ *
+ * @param conn_handle The connection over which to execute the
+ * procedure.
+ * @param chr_val_handle The value attribute handle of the
+ * characteristic to include in the outgoing
+ * notification.
+ *
+ * @return 0 on success; nonzero on failure.
*/
int ble_gattc_notify(uint16_t conn_handle, uint16_t chr_val_handle);
@@ -752,8 +772,18 @@ int ble_gatts_notify_multiple(uint16_t conn_handle,
*/
int ble_gatts_indicate_custom(uint16_t conn_handle, uint16_t chr_val_handle,
struct os_mbuf *txom);
+
/**
- * Deprecated. Should not be used. Use ble_gatts_indicate_custom instead.
+ * @deprecated Should not be used. Use ble_gatts_indicate_custom instead.
+ *
+ * @param conn_handle The connection over which to execute the
+ * procedure.
+ * @param chr_val_handle The value attribute handle of the
+ * characteristic to include in the outgoing
+ * indication.
+ * @param txom The data to include in the indication.
+ *
+ * @return 0 on success; nonzero on failure.
*/
int ble_gattc_indicate_custom(uint16_t conn_handle, uint16_t chr_val_handle,
struct os_mbuf *txom);
@@ -773,11 +803,16 @@ int ble_gattc_indicate_custom(uint16_t conn_handle, uint16_t chr_val_handle,
int ble_gatts_indicate(uint16_t conn_handle, uint16_t chr_val_handle);
/**
- * Deprecated. Should not be used. Use ble_gatts_indicate instead.
+ * @deprecated Should not be used. Use ble_gatts_indicate instead.
+ * @copydoc ble_gatts_indicate
*/
int ble_gattc_indicate(uint16_t conn_handle, uint16_t chr_val_handle);
-/** Initialize the BLE GATT client. */
+/**
+ * Initialize the BLE GATT client
+ *
+ * @return 0 on success; nonzero on failure.
+ */
int ble_gattc_init(void);
/*** @server. */