[LLC, Persistence] Add doc comments

Signed-off-by: Sahil Kumar <[email protected]>
2021-01-28 19:48:54 +05:30
parent 6e5894eebe
commit 86a122aa23
30 changed files with 154 additions and 68 deletions
@@ -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,