Skip to content

Commit 54b0c5a

Browse files
VelikovPetarclaude
andcommitted
docs(llc): use // for the private channel state write paths
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 36366c0 commit 54b0c5a

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

packages/stream_chat/lib/src/client/channel/channel_client_state.dart

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ class ChannelClientState {
6060
StreamChatClient get _client => _channel.client;
6161
final _subscriptions = CompositeSubscription();
6262

63-
/// Removes the [watcher] from the channel state, optionally updating the
64-
/// [watcherCount] when provided.
63+
// Removes the watcher from the channel state, optionally updating the
64+
// watcher count when provided.
6565
void _removeWatcher(User watcher, {int? watcherCount}) {
6666
// Writes the state directly: the watcher list merge in
6767
// [updateChannelState] would undo the removal.
@@ -72,9 +72,8 @@ class ChannelClientState {
7272
);
7373
}
7474

75-
/// Replaces the member matching [member]'s user id in the channel state.
76-
///
77-
/// Does nothing if no member with the same user id exists.
75+
// Replaces the member matching the given member's user id in the channel
76+
// state. Does nothing if no member with the same user id exists.
7877
void _updateMember(Member member) {
7978
final currentMembers = [...members];
8079
final memberIndex = currentMembers.indexWhere(
@@ -691,12 +690,12 @@ class ChannelClientState {
691690
Map<User, Event> get typingEvents => _typingEventsController.value;
692691
final _typingEventsController = BehaviorSubject.seeded(<User, Event>{});
693692

694-
/// Adds or replaces the typing [event] for the given [user].
693+
// Adds or replaces the typing event for the given user.
695694
void _upsertTypingEvent(User user, Event event) {
696695
_typingEventsController.safeAdd({...typingEvents, user: event});
697696
}
698697

699-
/// Removes the typing event for the given [user], if any.
698+
// Removes the typing event for the given user, if any.
700699
void _removeTypingEvent(User user) {
701700
_typingEventsController.safeAdd({...typingEvents}..remove(user));
702701
}
@@ -793,8 +792,8 @@ class ChannelClientState {
793792
);
794793
}
795794

796-
/// Deletes all messages from the user identified by [userId], both from
797-
/// the persistence layer and the channel state.
795+
// Deletes all messages from the user identified by the given id, both from
796+
// the persistence layer and the channel state.
798797
Future<void> _deleteMessagesFromUser({
799798
required String userId,
800799
bool hardDelete = false,

0 commit comments

Comments
 (0)