From 75b59f0b518f0baf2c2a7f90e2359dc62386e7f1 Mon Sep 17 00:00:00 2001
From: Sahil Kumar <xdsahil@gmail.com>
Date: Wed, 28 Apr 2021 15:45:08 +0530
Subject: [PATCH] add doc comments

Signed-off-by: Sahil Kumar <xdsahil@gmail.com>
---
 packages/stream_chat/lib/src/models/filter.dart | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/packages/stream_chat/lib/src/models/filter.dart b/packages/stream_chat/lib/src/models/filter.dart
index 6cda6f91..2356c57b 100644
--- a/packages/stream_chat/lib/src/models/filter.dart
+++ b/packages/stream_chat/lib/src/models/filter.dart
@@ -164,19 +164,25 @@ class Filter extends Equatable {
     String? key,
   }) = Filter.__;
 
-  /// Operator to use in filter.
+  /// An operator used for the filter. The operator string must start with `$`
   final String operator;
 
+  /// The "left-hand" side of the filter.
+  /// Specifies the name of the field the filter should match.
   ///
+  /// Some operators like `and` or `or`,
+  /// don't require the key value to be present.
+  /// see-more : [_groupOperators]
   final String? key;
 
-  ///
+  /// The "right-hand" side of the filter.
+  /// Specifies the [value] the filter should match.
   final Object /*List<Object>|List<Filter>|String*/ value;
 
   @override
   List<Object?> get props => [operator, key, value];
 
-  ///
+  /// Serializes to json object
   Map<String, Object> toJson() {
     final json = <String, Object>{};
     final groupOperators = _groupOperators.map((it) => it.rawValue);