[LLC, Persistence] Add doc comments

Signed-off-by: Sahil Kumar <[email protected]>

packages/stream_chat_persistence/lib/src/mapper/channel_mapper.dart

@@ -1,9 +1,9 @@
 import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 
-///
+/// Useful mapping functions for [ChannelEntity]
 extension ChannelEntityX on ChannelEntity {
-  ///
+  /// Maps a [ChannelEntity] into [ChannelModel]
   ChannelModel toChannelModel({User createdBy}) {
     final config = ChannelConfig.fromJson(this.config ?? {});
     return ChannelModel(
@@ -22,7 +22,7 @@ extension ChannelEntityX on ChannelEntity {
     );
   }
 
-  ///
+  /// Maps a [ChannelEntity] into [ChannelState]
   ChannelState toChannelState({
     User createdBy,
     List<Member> members,
@@ -38,9 +38,9 @@ extension ChannelEntityX on ChannelEntity {
   }
 }
 
-///
+/// Useful mapping functions for [ChannelModel]
 extension ChannelModelX on ChannelModel {
-  ///
+  /// Maps a [ChannelModel] into [ChannelEntity]
   ChannelEntity toEntity() {
     return ChannelEntity(
       id: id,

packages/stream_chat_persistence/lib/src/mapper/event_mapper.dart

@@ -1,10 +1,9 @@
 import 'package:stream_chat/stream_chat.dart';
-import 'user_mapper.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 
-///
+/// Useful mapping functions for [ConnectionEventEntity]
 extension ConnectionEventX on ConnectionEventEntity {
-  ///
+  /// Maps a [ConnectionEventEntity] into [Event]
   Event toEvent() {
     return Event(
       me: ownUser != null ? OwnUser.fromJson(ownUser) : null,

packages/stream_chat_persistence/lib/src/mapper/member_mapper.dart

@@ -1,10 +1,9 @@
 import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
-import 'user_mapper.dart';
 
-///
+/// Useful mapping functions for [MemberEntity]
 extension MemberEntityX on MemberEntity {
-  ///
+  /// Maps a [MemberEntity] into [Member]
   Member toMember({User user}) {
     return Member(
       user: user,
@@ -22,9 +21,9 @@ extension MemberEntityX on MemberEntity {
   }
 }
 
-///
+/// Useful mapping functions for [Member]
 extension MemberX on Member {
-  ///
+  /// Maps a [Member] into [MemberEntity]
   MemberEntity toEntity({String cid}) {
     return MemberEntity(
       userId: user?.id,

packages/stream_chat_persistence/lib/src/mapper/message_mapper.dart

@@ -3,9 +3,9 @@ import 'dart:convert';
 import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 
-///
+/// Useful mapping functions for [MessageEntity]
 extension MessageEntityX on MessageEntity {
-  ///
+  /// Maps a [MessageEntity] into [Message]
   Message toMessage({
     User user,
     List<Reaction> latestReactions,
@@ -41,9 +41,9 @@ extension MessageEntityX on MessageEntity {
   }
 }
 
-///
+/// Useful mapping functions for [Message]
 extension MessageX on Message {
-  ///
+  /// Maps a [Message] into [MessageEntity]
   MessageEntity toEntity({String cid}) {
     return MessageEntity(
       id: id,

packages/stream_chat_persistence/lib/src/mapper/reaction_mapper.dart

@@ -1,9 +1,9 @@
 import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 
-///
+/// Useful mapping functions for [ReactionEntity]
 extension ReactionEntityX on ReactionEntity {
-  ///
+  /// Maps a [ReactionEntity] into [Reaction]
   Reaction toReaction({User user}) {
     return Reaction(
       extraData: extraData,
@@ -17,10 +17,9 @@ extension ReactionEntityX on ReactionEntity {
   }
 }
 
-///
+/// Useful mapping functions for [Reaction]
 extension ReactionX on Reaction {
-  ///
-  ReactionEntity toEntity() {
+   ReactionEntity toEntity() {
     return ReactionEntity(
       extraData: extraData,
       type: type,

packages/stream_chat_persistence/lib/src/mapper/read_mapper.dart

@@ -1,10 +1,9 @@
 import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
-import 'user_mapper.dart';
 
-///
+/// Useful mapping functions for [ReadEntity]
 extension ReadEntityX on ReadEntity {
-  ///
+  /// Maps a [ReadEntity] into [Read]
   Read toRead({User user}) {
     return Read(
       user: user,
@@ -14,9 +13,9 @@ extension ReadEntityX on ReadEntity {
   }
 }
 
-///
+/// Useful mapping functions for [Read]
 extension ReadX on Read {
-  ///
+  /// Maps a [Read] into [ReadEntity]
   ReadEntity toEntity({String cid}) {
     return ReadEntity(
       lastRead: lastRead,

packages/stream_chat_persistence/lib/src/mapper/user_mapper.dart

@@ -1,9 +1,9 @@
 import 'package:stream_chat/stream_chat.dart';
 import 'package:stream_chat_persistence/src/db/moor_chat_database.dart';
 
-///
+/// Useful mapping functions for [UserEntity]
 extension UserEntityX on UserEntity {
-  ///
+  /// Maps a [UserEntity] into [User]
   User toUser() {
     return User(
       id: id,
@@ -18,9 +18,9 @@ extension UserEntityX on UserEntity {
   }
 }
 
-///
+/// Useful mapping functions for [User]
 extension UserX on User {
-  ///
+  /// Maps a [User] into [UserEntity]
   UserEntity toEntity() {
     return UserEntity(
       id: id,