From: Wootak Jung <wootak.jung@samsung.com>
Date: Thu, 23 May 2024 01:20:23 +0000 (+0900)
Subject: Update API document
X-Git-Tag: accepted/tizen/unified/20240703.100012~4
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b15d0962ce2e2c5a7afb8450e2c077be39d0866a;p=platform%2Fcore%2Fapi%2Fbluetooth.git

Update API document

Change-Id: I4176eb9470254b98a1e7b205ef91929aa97cb585
Signed-off-by: Wootak Jung <wootak.jung@samsung.com>
---

diff --git a/include/bluetooth.h b/include/bluetooth.h
index c38726a..aa74ad2 100644
--- a/include/bluetooth.h
+++ b/include/bluetooth.h
@@ -1083,6 +1083,8 @@ int bt_adapter_le_free_ibeacon_report(bt_adapter_le_ibeacon_scan_result_info_s *
  * @brief Creates advertiser to advertise device's existence or respond to LE scanning request.
  * @since_tizen 2.3
  *
+ * @remarks The @a advertiser should be released using bt_adapter_le_destroy_advertiser().
+ *
  * @param[out] advertiser The handle of advertiser
  *
  * @return 0 on success, otherwise a negative error value.
@@ -1095,6 +1097,16 @@ int bt_adapter_le_free_ibeacon_report(bt_adapter_le_ibeacon_scan_result_info_s *
  * @pre The Bluetooth service must be initialized with bt_initialize().
  *
  * @see bt_adapter_le_destroy_advertiser()
+ *
+ * @code
+ * #include <bluetooth.h>
+ * ...
+ * bt_advertiser_h advertiser = NULL;
+ * bt_adapter_le_create_advertiser(&advertiser);
+ * ...
+ * bt_adapter_le_destroy_advertiser(advertiser);
+ * ...
+ * @endcode
  */
 int bt_adapter_le_create_advertiser(bt_advertiser_h *advertiser);
 
@@ -4409,6 +4421,8 @@ int bt_gatt_client_destroy(bt_gatt_client_h client);
  * @brief  Gets the address of remote device.
  * @since_tizen 2.3.1
  *
+ * @remarks The @a remote_address should be released using free().
+ *
  * @param[in] client The created GATT client's handle
  * @param[out] remote_address The address of the remote device which is associated with @a client
  * @return 0 on success, otherwise a negative error value
@@ -4417,6 +4431,18 @@ int bt_gatt_client_destroy(bt_gatt_client_h client);
  * @retval #BT_ERROR_INVALID_PARAMETER Invalid parameter
  *
  * @see bt_gatt_client_create()
+ *
+ * @code
+ * #include <bluetooth.h>
+ * ...
+ * bt_gatt_client_h client = NULL;
+ * char *remote_address = NULL;
+ * ...
+ * bt_gatt_client_create("AA:AA:AA:AA:AA:AA", &client);
+ * bt_gatt_client_get_remote_address(client, &remote_address);
+ * free(remote_address);
+ * ...
+ * @endcode
  */
 int bt_gatt_client_get_remote_address(bt_gatt_client_h client,
 					char **remote_address);