From fab68d2cc9f37d504edf7ff043acb840bf03cd61 Mon Sep 17 00:00:00 2001 From: Wootak Jung Date: Mon, 30 Sep 2024 09:13:38 +0900 Subject: [PATCH] [Bluetooth] Reinforce API documents Signed-off-by: Wootak Jung --- .../Tizen.Network.Bluetooth/BluetoothDevice.cs | 4 ++-- .../Tizen.Network.Bluetooth/BluetoothGatt.cs | 6 +++--- .../Tizen.Network.Bluetooth/BluetoothServerSocket.cs | 2 +- .../Tizen.Network.Bluetooth/BluetoothSocket.cs | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs index c5ae56d77a4..d08694c521e 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs @@ -694,7 +694,7 @@ public bool IsProfileConnected(BluetoothProfileType profileType) } /// - /// Returns the instance of the Bluetooth profile type. + /// It creates an instance of the specified profile and sets the remote address of the profile. /// /// /// The Bluetooth must be enabled. @@ -717,7 +717,7 @@ public T GetProfile() where T : BluetoothProfile } /// - /// Creates the client socket. + /// Creates a new client socket object for connecting to a Bluetooth server using the specified service UUID. /// /// The IBluetoothClientSocket instance. /// The UUID of the service. diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs index 5eb7b0ab64c..4b2c03294a5 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs @@ -674,7 +674,7 @@ internal BluetoothGattService(BluetoothGattServiceImpl impl, string uuid) public string Uuid { get; } /// - /// Adds a characteristic to this service. + /// Associates a Bluetooth GATT Characteristic with this GATT Service. /// /// The characteristic to be added. /// true on success, false otherwise. @@ -718,7 +718,7 @@ public IEnumerable GetCharacteristics() } /// - /// Includes a service to this service. + /// Registers a Bluetooth GATT Service within this existing GATT Primary Service. /// /// The service to be included. /// true on success, false otherwise @@ -997,7 +997,7 @@ internal override BluetoothGattAttributeImpl Impl } /// - /// Adds a descriptor to this characteristic. + /// Attaches a Bluetooth GATT Descriptor to this GATT Characteristic. /// /// The descriptor to be added. /// true on success, false otherwise. diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs index 4c78defdeae..3a9f3bc74bd 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs @@ -134,7 +134,7 @@ private static void UnregisterAcceptStateChangedEvent() } /// - /// Starts listening on the passed RFCOMM socket and accepts connection requests. + /// Initiates the process of accepting incoming connections on a previously created RFCOMM server socket. /// /// /// The socket must be created with CreateServerSocket(). This API invokes the ConnectionStateChanged event. diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs index 44d7ba3cc8b..2228d47b5dc 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs @@ -208,7 +208,7 @@ private void UnregisterConnectionStateChangedEvent() } /// - /// Connects to a specific RFCOMM based service on a remote Bluetooth device UUID. + /// Establishes a point-to-point communication link with a remote Bluetooth device via an RFCOMM channel identified by the specified UUID. /// /// /// The bluetooth must be enabled, discoverable with StartDiscovery(), and bonded with the remote device using CreateBond(). The ConnectionStateChanged event is raised once this API is called. @@ -266,7 +266,7 @@ public int SendData(string data) } /// - /// Sends data to the connected device. + /// Sends raw binary data to the currently connected Bluetooth device over the established connection. /// /// The number of bytes written (zero indicates nothing was written). ///