From 717a7abebf4763e55035e5e50888d85d9bc29ba1 Mon Sep 17 00:00:00 2001 From: Wootak Jung Date: Thu, 8 Aug 2024 15:20:26 +0900 Subject: [PATCH] Update API document Change-Id: Icb144b97f36e25d141ee2e3624e04fc4753a0e29 Signed-off-by: Wootak Jung --- doc/bluetooth_doc.h | 40 +++++++----------------------------- include/bluetooth_internal.h | 2 +- include/bluetooth_type.h | 20 +++++++++++++----- 3 files changed, 23 insertions(+), 39 deletions(-) diff --git a/doc/bluetooth_doc.h b/doc/bluetooth_doc.h index 1638a4c..59db437 100644 --- a/doc/bluetooth_doc.h +++ b/doc/bluetooth_doc.h @@ -640,32 +640,6 @@ * */ -/** - * @defgroup CAPI_NETWORK_BLUETOOTH_HID_MODULE Bluetooth HID - * @brief Bluetooth HID(Human Interface Device) API provides functions for connecting to Bluetooth HID such as keyboards and mouse. - * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE - * - * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_HEADER Required Header - * \#include - * - * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_OVERVIEW Overview - * In HID Profile, there are two roles - @a Host and @a Device. - * The @a Host is a device that uses or requests the services of a HID. The @a Device is a device that provides the service of human data input and output to and from the @a Host. - * This API only supports @a Host role. - * - * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_FEATURE Related Features - * This API is related with the following features:\n - * - %http://tizen.org/feature/network.bluetooth.hid\n - * - * It is recommended to design feature related codes in your application for reliability.\n - * - * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n - * - * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n - * - * More details on featuring your application can be found from Feature Element. - */ - /** * @defgroup CAPI_NETWORK_BLUETOOTH_HID_MODULE Bluetooth HID * @brief Bluetooth HID(Human Interface Device) API provides functions for connecting to Bluetooth HID such as keyboards and mouse. @@ -695,18 +669,18 @@ /** * @defgroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE Bluetooth HID Host - * @brief Bluetooth HID(Human Interface Device) API provides functions for connecting to Bluetooth HID such as keyboards and mouse. + * @brief Bluetooth HID(Human Interface Device) Host API provides functions for connecting to Bluetooth HID Device such as keyboards and mouse. * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * - * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_HEADER Required Header + * @section CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE_HEADER Required Header * \#include * - * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_OVERVIEW Overview + * @section CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE_OVERVIEW Overview * In HID Profile, there are two roles - @a Host and @a Device. - * The @a Host is a device that uses or requests the services of a HID. The @a Device is a device that provides the service of human data input and output to and from th + * The @a Host is a device that uses or requests the services of a HID. The @a Device is a device that provides the service of human data input and output to and from the @a Host. * This API only supports @a Host role. * - * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_FEATURE Related Features + * @section CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.bluetooth.hid\n * @@ -721,7 +695,7 @@ /** * @defgroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE Bluetooth HID Device - * @brief The Bluetooth HID (Human Interface Device) API provides functions for connecting Bluetooth HID such as keyboards and mice. + * @brief The Bluetooth HID (Human Interface Device) Device API provides functions for connecting to Bluetooth HID Host such as mobile and tablet. * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE * * @section CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE_HEADER Required Header @@ -1070,7 +1044,7 @@ * This set of functions is used for exchanging the hash key and randomizer. * This API uses an external means of communication, such as near-field communication (NFC) to exchange some information used in the pairing process. * - * @section CAPI_NETWORK_BLUETOOTH_HDP_MODULE_FEATURE Related Features + * @section CAPI_NETWORK_BLUETOOTH_OOB_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.bluetooth.oob\n * diff --git a/include/bluetooth_internal.h b/include/bluetooth_internal.h index e07f92b..78503ed 100644 --- a/include/bluetooth_internal.h +++ b/include/bluetooth_internal.h @@ -3654,7 +3654,7 @@ int bt_dpm_get_data_transfer_state(bt_dpm_status_e *value); int bt_pbap_client_is_connected(const char *address, bool *connected_status); /** - * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE * @brief Sends the custom event data. * @since_tizen 3.0 * @privlevel platform diff --git a/include/bluetooth_type.h b/include/bluetooth_type.h index aa1f430..a2e4001 100644 --- a/include/bluetooth_type.h +++ b/include/bluetooth_type.h @@ -31,10 +31,9 @@ extern "C" /** * @file bluetooth_type.h * @brief API to control the Bluetooth adapter, devices and communications. - * @ingroup CAPI_NETWORK_BLUETOOTH_TYPE_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE */ - /** * @ingroup CAPI_NETWORK_BLUETOOTH_PBAP_MODULE * @brief Enumeration of PBAP fields. @@ -495,6 +494,7 @@ typedef enum { } bt_audio_profile_type_e; /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Enumerations for the call handling event. * @since_tizen 2.3 @@ -506,6 +506,7 @@ typedef enum { } bt_ag_call_handling_event_e; /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Enumerations for the multi call handling event. * @since_tizen 2.3 @@ -771,7 +772,8 @@ typedef enum { } bt_gatt_att_request_type_e; /** - * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE + * @internal + * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE * @brief Enumerations for the types of PAN (Personal Area Networking) service. * @since_tizen 2.3 */ @@ -863,6 +865,7 @@ typedef void *bt_gatt_client_h; typedef void *bt_gatt_server_h; /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief The handle of calls state. * @since_tizen 2.3 @@ -1446,6 +1449,7 @@ typedef void (*bt_opp_client_push_finished_cb)(int result, const char *remote_ad typedef void (*bt_audio_connection_state_changed_cb) (int result, bool connected, const char *remote_address, bt_audio_profile_type_e type, void *user_data); /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Called when a call handling event happened from Hands-Free. * @since_tizen 2.3 @@ -1459,6 +1463,7 @@ typedef void (*bt_audio_connection_state_changed_cb) (int result, bool connected typedef void (*bt_ag_call_handling_event_cb) (bt_ag_call_handling_event_e event, unsigned int call_id, void *user_data); /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Called when a multi call handling event happened from Hands-Free. * @since_tizen 2.3 @@ -1471,6 +1476,7 @@ typedef void (*bt_ag_call_handling_event_cb) (bt_ag_call_handling_event_e event, typedef void (*bt_ag_multi_call_handling_event_cb) (bt_ag_multi_call_handling_event_e event, void *user_data); /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Called when a DTMF (Dual Tone Multi Frequency) is transmitted from Hands-Free. * @since_tizen 2.3 @@ -1483,6 +1489,7 @@ typedef void (*bt_ag_multi_call_handling_event_cb) (bt_ag_multi_call_handling_ev typedef void (*bt_ag_dtmf_transmitted_cb) (const char *dtmf, void *user_data); /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Called when the speaker gain of the remote device is changed. * @since_tizen 2.3 @@ -1495,6 +1502,7 @@ typedef void (*bt_ag_dtmf_transmitted_cb) (const char *dtmf, void *user_data); typedef void (*bt_ag_speaker_gain_changed_cb) (int gain, void *user_data); /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_AUDIO_AG_MODULE * @brief Called when the microphone gain of the remote device is changed. * @since_tizen 2.3 @@ -1568,7 +1576,7 @@ typedef void (*bt_avrcp_shuffle_mode_changed_cb) (bt_avrcp_shuffle_mode_e shuffl typedef void (*bt_avrcp_scan_mode_changed_cb) (bt_avrcp_scan_mode_e scan, void *user_data); /** - * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE * @brief Called when the connection state is changed. * * @details This callback is called when the connection state is changed. @@ -1891,6 +1899,7 @@ typedef void (*bt_gatt_server_notification_sent_cb) (int result, bt_gatt_h characteristic, bool completed, void *user_data); /** + * @internal * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE * @brief Called when the connection state is changed. * @since_tizen 2.3 @@ -1905,7 +1914,8 @@ typedef void (*bt_gatt_server_notification_sent_cb) (int result, typedef void (*bt_nap_connection_state_changed_cb) (bool connected, const char *remote_address, const char *interface_name, void *user_data); /** - * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_PANU_MODULE + * @internal + * @ingroup CAPI_NETWORK_BLUETOOTH_PAN_NAP_MODULE * @brief Called when the connection state is changed. * * @details This callback is called when the connection state is changed. -- 2.34.1