Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bluetooth] Reinforce API documents #6385

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@ public bool IsProfileConnected(BluetoothProfileType profileType)
}

/// <summary>
/// Returns the instance of the Bluetooth profile type.
/// It creates an instance of the specified profile and sets the remote address of the profile.
/// </summary>
/// <remarks>
/// The Bluetooth must be enabled.
Expand All @@ -717,7 +717,7 @@ public T GetProfile<T>() where T : BluetoothProfile
}

/// <summary>
/// Creates the client socket.
/// Creates a new client socket object for connecting to a Bluetooth server using the specified service UUID.
/// </summary>
/// <returns>The IBluetoothClientSocket instance.</returns>
/// <param name="serviceUuid">The UUID of the service.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,7 @@ internal BluetoothGattService(BluetoothGattServiceImpl impl, string uuid)
public string Uuid { get; }

/// <summary>
/// Adds a characteristic to this service.
/// Associates a Bluetooth GATT Characteristic with this GATT Service.
/// </summary>
/// <param name="characteristic">The characteristic to be added.</param>
/// <returns>true on success, false otherwise.</returns>
Expand Down Expand Up @@ -718,7 +718,7 @@ public IEnumerable<BluetoothGattCharacteristic> GetCharacteristics()
}

/// <summary>
/// Includes a service to this service.
/// Registers a Bluetooth GATT Service within this existing GATT Primary Service.
/// </summary>
/// <param name="service">The service to be included.</param>
/// <returns>true on success, false otherwise</returns>
Expand Down Expand Up @@ -997,7 +997,7 @@ internal override BluetoothGattAttributeImpl Impl
}

/// <summary>
/// Adds a descriptor to this characteristic.
/// Attaches a Bluetooth GATT Descriptor to this GATT Characteristic.
/// </summary>
/// <param name="descriptor">The descriptor to be added.</param>
/// <returns>true on success, false otherwise.</returns>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ private static void UnregisterAcceptStateChangedEvent()
}

/// <summary>
/// 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.
/// </summary>
/// <remarks>
/// The socket must be created with CreateServerSocket(). This API invokes the ConnectionStateChanged event.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ private void UnregisterConnectionStateChangedEvent()
}

/// <summary>
/// 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.
/// </summary>
/// <remarks>
/// 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.
Expand Down Expand Up @@ -266,7 +266,7 @@ public int SendData(string data)
}

/// <summary>
/// Sends data to the connected device.
/// Sends raw binary data to the currently connected Bluetooth device over the established connection.
/// </summary>
/// <returns>The number of bytes written (zero indicates nothing was written).</returns>
/// <remarks>
Expand Down
Loading