docs: genericParameters macro

Author: sachaarbonel

packages/stream_feed_flutter_core/lib/src/bloc/feed_bloc.dart

@@ -6,8 +6,8 @@ import 'package:stream_feed_flutter_core/src/extensions.dart';
 
 /// The generic version of feedBloc
 ///
-///{@macro feedBloc}
-
+/// {@macro feedBloc}
+/// {@macro genericParameters}
 class GenericFeedBloc<A, Ob, T, Or> {
   GenericFeedBloc({required this.client, this.analyticsClient});
 

packages/stream_feed_flutter_core/lib/src/flat_feed_core.dart

@@ -10,6 +10,7 @@ import 'package:stream_feed_flutter_core/stream_feed_flutter_core.dart';
 /// The generic version of [FlatFeedCore]
 /// 
 ///{@macro flatFeedCore}
+///{@macro genericParameters}
 class GenericFlatFeedCore<A, Ob, T, Or> extends StatefulWidget {
   ///{@macro flatFeedCore}
   const GenericFlatFeedCore({

packages/stream_feed_flutter_core/lib/src/typedefs.dart

@@ -163,4 +163,17 @@ typedef FeedProvider = GenericFeedProvider<User, String, String, String>;
 /// FeedProvider.of(context).bloc.onRemoveChildReaction()
 /// ```
 /// {@endtemplate}
+/// 
+/// {@template genericParameters}
+/// The generic parameters can be of the following type:
+/// A = [actor] can be an User, or a String
+/// Ob = [object] can a String, or a CollectionEntry
+/// T = [target] can be a String or an Activity
+/// Or = [origin] can be a String or a Reaction or an User
+///
+/// To avoid potential runtime errors
+/// make sure they are the same across the app if
+/// you go the route of using Generic* classes
+/// 
+/// {@endtemplate}
 typedef FeedBloc = GenericFeedBloc<User, String, String, String>;