Skip to content

Commit 071f2f7

Browse files
committed
Improve summaries
1 parent 2060dee commit 071f2f7

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

Assets/Plugins/StreamChat/Core/LowLevelClient/IStreamChatLowLevelClient.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ namespace StreamChat.Core.LowLevelClient
1414
public delegate void ConnectionStateChangeHandler(ConnectionState previous, ConnectionState current);
1515

1616
/// <summary>
17-
/// Stream Chat Client
17+
/// Stream Low-Level Chat Client - maintains WebSockets connection, executes API calls and exposes Stream events to which you can subscribe.
18+
/// There should be only one instance of this client in your application. This client does NOT maintain state.
19+
///
20+
/// Unless you have a good reason to use the low-level client, you should be using the stateful <see cref="IStreamChatClient"/> which maintain client state
1821
/// </summary>
1922
public interface IStreamChatLowLevelClient : IAuthProvider, IConnectionProvider, IStreamRealtimeEventsProvider, IDisposable
2023
{

Assets/Plugins/StreamChat/Core/LowLevelClient/StreamChatLowLevelClient.cs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,7 @@
3939

4040
namespace StreamChat.Core.LowLevelClient
4141
{
42-
/// <summary>
43-
/// Stream Low-Level Chat Client - maintains WebSockets connection, executes API calls and exposes Stream events to which you can subscribe.
44-
/// There should be only one instance of this client in your application. This client does NOT maintain state.
45-
///
46-
/// Unless you have a good reason to use the low-level client, you should be using the stateful <see cref="IStreamChatClient"/> which maintain client state
47-
/// </summary>
42+
/// <inheritdoc cref="IStreamChatLowLevelClient"/>
4843
public class StreamChatLowLevelClient : IStreamChatLowLevelClient
4944
{
5045
public const string MenuPrefix = "Stream/";

Assets/Plugins/StreamChat/Core/StreamChatClient.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ namespace StreamChat.Core
6666
/// </summary>
6767
public delegate void ChannelMemberRemovedHandler(IStreamChannel channel, IStreamChannelMember member);
6868

69+
/// <inheritdoc cref="IStreamChatClient"/>
6970
public sealed class StreamChatClient : IStreamChatClient
7071
{
7172
public event ConnectionMadeHandler Connected;

0 commit comments

Comments
 (0)