Skip to content

Commit 69e0d6a

Browse files
committed
more docs
1 parent b006118 commit 69e0d6a

File tree

5 files changed

+25
-16
lines changed

5 files changed

+25
-16
lines changed

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

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,23 @@ class GenericFeedBloc<A, Ob, T, Or> {
232232

233233
/* REACTIONS */
234234

235-
/// Add a new reaction to the feed.
235+
/// {@template onAddReaction}
236+
/// Add a new reaction to the feed
237+
/// in a reactive way.
238+
/// For example to add a comment under a tweet:
239+
/// ```dart
240+
/// FeedProvider.of(context).bloc.onAddReaction(kind:'comment',
241+
/// activity: activities[idx],feedGroup:'user'),
242+
/// data: {'text': trimmedText}
243+
/// ```
244+
/// {@endtemplate}
245+
236246
Future<Reaction> onAddReaction({
237-
Map<String, Object>? data,
238247
required String kind,
239248
required GenericEnrichedActivity<A, Ob, T, Or> activity,
240-
List<FeedId>? targetFeeds,
241249
required String feedGroup,
250+
List<FeedId>? targetFeeds,
251+
Map<String, Object>? data,
242252
}) async {
243253
final reaction = await client.reactions
244254
.add(kind, activity.id!, targetFeeds: targetFeeds, data: data);

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ import 'package:stream_feed_flutter_core/src/bloc/feed_bloc.dart';
44

55
/// The generic version of [FeedProvider]
66
///
7-
///{@macro feedProvider}
7+
/// {@macro feedProvider}
8+
/// {@macro genericParameters}
89
class GenericFeedProvider<A, Ob, T, Or> extends InheritedWidget {
910
const GenericFeedProvider({
1011
Key? key,

packages/stream_feed_flutter_core/lib/src/flat_feed_core.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import 'package:stream_feed_flutter_core/stream_feed_flutter_core.dart';
99

1010
/// The generic version of [FlatFeedCore]
1111
///
12-
///{@macro flatFeedCore}
13-
///{@macro genericParameters}
12+
/// {@macro flatFeedCore}
13+
/// {@macro genericParameters}
1414
class GenericFlatFeedCore<A, Ob, T, Or> extends StatefulWidget {
1515
///{@macro flatFeedCore}
1616
const GenericFlatFeedCore({

packages/stream_feed_flutter_core/lib/src/reactions_list_core.dart

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ import 'package:stream_feed_flutter_core/stream_feed_flutter_core.dart';
1111
//TODO: other things to add to core: FollowListCore, UserListCore
1212

1313
/// The generic version of [ReactionListCore]
14-
///
15-
///{@macro reactionListCore}
14+
///
15+
/// {@macro reactionListCore}
16+
/// {@macro genericParameters}
1617
class GenericReactionListCore<A, Ob, T, Or> extends StatefulWidget {
1718
///{@macro reactionListCore}
1819
const GenericReactionListCore({

packages/stream_feed_flutter_core/lib/src/typedefs.dart

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,7 @@ typedef FeedProvider = GenericFeedProvider<User, String, String, String>;
146146
/// ```dart
147147
/// FeedProvider.of(context).bloc.onRemoveActivity()
148148
/// ```
149-
/// - add reactions (comment under a tweet) in a reactive way
150-
/// ```dart
151-
/// FeedProvider.of(context).bloc.onAddReaction()
152-
/// ```
149+
/// - {@macro onAddReaction}
153150
/// - remove reacitons (delete a comment under a tweet) in a reactive way
154151
/// ```dart
155152
/// FeedProvider.of(context).bloc.onRemoveReaction()
@@ -166,10 +163,10 @@ typedef FeedProvider = GenericFeedProvider<User, String, String, String>;
166163
///
167164
/// {@template genericParameters}
168165
/// The generic parameters can be of the following type:
169-
/// A = [actor] can be an User, or a String
170-
/// Ob = [object] can a String, or a CollectionEntry
171-
/// T = [target] can be a String or an Activity
172-
/// Or = [origin] can be a String or a Reaction or an User
166+
/// - A : [actor] can be an User, or a String
167+
/// - Ob : [object] can a String, or a CollectionEntry
168+
/// - T : [target] can be a String or an Activity
169+
/// - Or : [origin] can be a String or a Reaction or an User
173170
///
174171
/// To avoid potential runtime errors
175172
/// make sure they are the same across the app if

0 commit comments

Comments
 (0)