chore: fix dart doc warnings

Author: appflowy

frontend/app_flowy/lib/plugins/board/application/board_bloc.dart

@@ -22,7 +22,7 @@ part 'board_bloc.freezed.dart';
 
 class BoardBloc extends Bloc<BoardEvent, BoardState> {
   final BoardDataController _gridDataController;
-  late final AppFlowyBoardDataController boardController;
+  late final AppFlowyBoardController boardController;
   final MoveRowFFIService _rowService;
   LinkedHashMap<String, GroupController> groupControllers = LinkedHashMap();
 
@@ -34,7 +34,7 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
       : _rowService = MoveRowFFIService(gridId: view.id),
         _gridDataController = BoardDataController(view: view),
         super(BoardState.initial(view.id)) {
-    boardController = AppFlowyBoardDataController(
+    boardController = AppFlowyBoardController(
       onMoveGroup: (
         fromColumnId,
         fromIndex,
@@ -165,10 +165,10 @@ class BoardBloc extends Bloc<BoardEvent, BoardState> {
     boardController.clear();
 
     //
-    List<AppFlowyBoardGroupData> columns = groups
+    List<AppFlowyGroupData> columns = groups
         .where((group) => fieldController.getField(group.fieldId) != null)
         .map((group) {
-      return AppFlowyBoardGroupData(
+      return AppFlowyGroupData(
         id: group.groupId,
         name: group.desc,
         items: _buildRows(group),
@@ -350,7 +350,7 @@ class BoardColumnItem extends AppFlowyGroupItem {
 
 class GroupControllerDelegateImpl extends GroupControllerDelegate {
   final GridFieldController fieldController;
-  final AppFlowyBoardDataController controller;
+  final AppFlowyBoardController controller;
   final void Function(String, RowPB, int?) onNewColumnItem;
 
   GroupControllerDelegateImpl({

frontend/app_flowy/lib/plugins/board/presentation/board_page.dart

@@ -63,7 +63,7 @@ class BoardContent extends StatefulWidget {
 
 class _BoardContentState extends State<BoardContent> {
   late ScrollController scrollController;
-  late AFBoardScrollManager scrollManager;
+  late AppFlowyBoardScrollManager scrollManager;
 
   final config = AppFlowyBoardConfig(
     groupBackgroundColor: HexColor.fromHex('#F7F8FC'),
@@ -72,7 +72,7 @@ class _BoardContentState extends State<BoardContent> {
   @override
   void initState() {
     scrollController = ScrollController();
-    scrollManager = AFBoardScrollManager();
+    scrollManager = AppFlowyBoardScrollManager();
     super.initState();
   }
 
@@ -104,7 +104,7 @@ class _BoardContentState extends State<BoardContent> {
       child: AppFlowyBoard(
         scrollManager: scrollManager,
         scrollController: scrollController,
-        dataController: context.read<BoardBloc>().boardController,
+        controller: context.read<BoardBloc>().boardController,
         headerBuilder: _buildHeader,
         footerBuilder: _buildFooter,
         cardBuilder: (_, column, columnItem) => _buildCard(
@@ -149,7 +149,7 @@ class _BoardContentState extends State<BoardContent> {
 
   Widget _buildHeader(
     BuildContext context,
-    AppFlowyBoardGroupData columnData,
+    AppFlowyGroupData columnData,
   ) {
     final boardCustomData = columnData.customData as BoardCustomData;
     return AppFlowyGroupHeader(
@@ -181,7 +181,7 @@ class _BoardContentState extends State<BoardContent> {
     );
   }
 
-  Widget _buildFooter(BuildContext context, AppFlowyBoardGroupData columnData) {
+  Widget _buildFooter(BuildContext context, AppFlowyGroupData columnData) {
     final boardCustomData = columnData.customData as BoardCustomData;
     final group = boardCustomData.group;
 
@@ -215,7 +215,7 @@ class _BoardContentState extends State<BoardContent> {
 
   Widget _buildCard(
     BuildContext context,
-    AppFlowyBoardGroupData column,
+    AppFlowyGroupData column,
     AppFlowyGroupItem columnItem,
   ) {
     final boardColumnItem = columnItem as BoardColumnItem;
@@ -242,7 +242,7 @@ class _BoardContentState extends State<BoardContent> {
       },
     );
 
-    return AppFlowyGroupItemCard(
+    return AppFlowyGroupCard(
       key: ValueKey(columnItem.id),
       margin: config.cardPadding,
       decoration: _makeBoxDecoration(context),

frontend/app_flowy/packages/appflowy_board/README.md

@@ -34,17 +34,83 @@ flutter pub add appflowy_board
 flutter pub get
 ```
 
-This will add a line like this to your package's pubspec.yaml (and run an implicit flutter pub get):
+This will add a line like this to your package's pubspec.yaml:
 ```dart
 dependencies:
   appflowy_board: ^0.0.6
 ```
 
-## Create board
+## Create your first board
+
+Initialize an `AppFlowyBoardController` for the board. It contains the data used by the board. You can
+register callbacks to receive the changes of the board.
+
+```dart
+
+final AppFlowyBoardController controller = AppFlowyBoardController(
+  onMoveGroup: (fromGroupId, fromIndex, toGroupId, toIndex) {
+    debugPrint('Move item from $fromIndex to $toIndex');
+  },
+  onMoveGroupItem: (groupId, fromIndex, toIndex) {
+    debugPrint('Move $groupId:$fromIndex to $groupId:$toIndex');
+  },
+  onMoveGroupItemToGroup: (fromGroupId, fromIndex, toGroupId, toIndex) {
+    debugPrint('Move $fromGroupId:$fromIndex to $toGroupId:$toIndex');
+  },
+);
+```
+
+Provide an initial value of the board by initializing the `AppFlowyGroupData`. It represents a group data and contains list of items. Each item displayed in the group requires to implement the `AppFlowyGroupItem` class.
+
+```dart
+
+void initState() {
+  final group1 = AppFlowyGroupData(id: "To Do", items: [
+    TextItem("Card 1"),
+    TextItem("Card 2"),
+  ]);
+  final group2 = AppFlowyGroupData(id: "In Progress", items: [
+    TextItem("Card 3"),
+    TextItem("Card 4"),
+  ]);
+
+  final group3 = AppFlowyGroupData(id: "Done", items: []);
+
+  controller.addGroup(group1);
+  controller.addGroup(group2);
+  controller.addGroup(group3);
+  super.initState();
+}
+
+class TextItem extends AppFlowyGroupItem {
+  final String s;
+  TextItem(this.s);
+
+  @override
+  String get id => s;
+}
+
+```
+
+Finally, return a `AppFlowyBoard` widget in the build method.
 
-Import the package in your Dart file:
 ```dart
-import 'package:appflowy_board/appflowy_board.dart';
+
+@override
+Widget build(BuildContext context) {
+  return AppFlowyBoard(
+    controller: controller,
+    cardBuilder: (context, group, groupItem) {
+      final textItem = groupItem as TextItem;
+      return AppFlowyGroupCard(
+        key: ObjectKey(textItem),
+        child: Text(textItem.s),
+      );
+    },
+    groupConstraints: const BoxConstraints.tightFor(width: 240),
+  ); 
+}
+
 ```
 
 ## Usage Example
@@ -53,16 +119,14 @@ First, run main.dart to play with the demo.
 
 
 Second, let's delve into multi_board_list_example.dart to understand a few key components:
-* A Board widget is created via instantiating an AFBoard() object. 
-* In the AFBoard() object, you can find:
-  * AFBoardDataController, which is defined in board_data.dart, is feeded with prepopulated mock data. It also contains callback functions to materialize future user data.
-  * Three builders: AppFlowyColumnHeader, AppFlowyColumnFooter, AppFlowyColumnItemCard. See below image for what they are used for.
-
+* A Board widget is created via instantiating an `AppFlowyBoard` object. 
+* In the `AppFlowyBoard` object, you can find the `AppFlowyBoardController`, which is defined in board_data.dart, is feeded with prepopulated mock data. It also contains callback functions to materialize future user data.
+* Three builders: AppFlowyBoardHeaderBuilder, AppFlowyBoardFooterBuilder, AppFlowyBoardCardBuilder. See below image for what they are used for.
 
 
-<!-- <p>
-<img src="https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_board/example/gifs/appflowy_board_builders.jpg?raw=true" width="100%" title="AppFlowyBoard">
-</p> -->
+<p>
+<img src="https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_board/example/gifs/appflowy_board_builders.jpg?raw=true" width="200" title="AppFlowyBoard">
+</p>
 
 ## Glossary
 Please refer to the API documentation.
@@ -74,6 +138,3 @@ Please look at [CONTRIBUTING.md](https://appflowy.gitbook.io/docs/essential-docu
 
 ## License
 Distributed under the AGPLv3 License. See [LICENSE](https://github.com/AppFlowy-IO/AppFlowy-Docs/blob/main/LICENSE) for more information.
-
-
-d

frontend/app_flowy/packages/appflowy_board/example/lib/multi_board_list_example.dart

@@ -9,22 +9,21 @@ class MultiBoardListExample extends StatefulWidget {
 }
 
 class _MultiBoardListExampleState extends State<MultiBoardListExample> {
-  final AppFlowyBoardDataController boardDataController =
-      AppFlowyBoardDataController(
-    onMoveGroup: (fromColumnId, fromIndex, toColumnId, toIndex) {
-      // debugPrint('Move column from $fromIndex to $toIndex');
+  final AppFlowyBoardController controller = AppFlowyBoardController(
+    onMoveGroup: (fromGroupId, fromIndex, toGroupId, toIndex) {
+      debugPrint('Move item from $fromIndex to $toIndex');
     },
-    onMoveGroupItem: (columnId, fromIndex, toIndex) {
-      // debugPrint('Move $columnId:$fromIndex to $columnId:$toIndex');
+    onMoveGroupItem: (groupId, fromIndex, toIndex) {
+      debugPrint('Move $groupId:$fromIndex to $groupId:$toIndex');
     },
-    onMoveGroupItemToGroup: (fromColumnId, fromIndex, toColumnId, toIndex) {
-      // debugPrint('Move $fromColumnId:$fromIndex to $toColumnId:$toIndex');
+    onMoveGroupItemToGroup: (fromGroupId, fromIndex, toGroupId, toIndex) {
+      debugPrint('Move $fromGroupId:$fromIndex to $toGroupId:$toIndex');
     },
   );
 
   @override
   void initState() {
-    List<AppFlowyGroupItem> a = [
+    final group1 = AppFlowyGroupData(id: "To Do", name: "To Do", items: [
       TextItem("Card 1"),
       TextItem("Card 2"),
       RichTextItem(title: "Card 3", subtitle: 'Aug 1, 2020 4:05 PM'),
@@ -34,11 +33,9 @@ class _MultiBoardListExampleState extends State<MultiBoardListExample> {
       RichTextItem(title: "Card 7", subtitle: 'Aug 1, 2020 4:05 PM'),
       RichTextItem(title: "Card 8", subtitle: 'Aug 1, 2020 4:05 PM'),
       TextItem("Card 9"),
-    ];
+    ]);
 
-    final column1 =
-        AppFlowyBoardGroupData(id: "To Do", name: "To Do", items: a);
-    final column2 = AppFlowyBoardGroupData(
+    final group2 = AppFlowyGroupData(
       id: "In Progress",
       name: "In Progress",
       items: <AppFlowyGroupItem>[
@@ -47,12 +44,12 @@ class _MultiBoardListExampleState extends State<MultiBoardListExample> {
       ],
     );
 
-    final column3 = AppFlowyBoardGroupData(
+    final group3 = AppFlowyGroupData(
         id: "Done", name: "Done", items: <AppFlowyGroupItem>[]);
 
-    boardDataController.addGroup(column1);
-    boardDataController.addGroup(column2);
-    boardDataController.addGroup(column3);
+    controller.addGroup(group1);
+    controller.addGroup(group2);
+    controller.addGroup(group3);
 
     super.initState();
   }
@@ -62,54 +59,45 @@ class _MultiBoardListExampleState extends State<MultiBoardListExample> {
     final config = AppFlowyBoardConfig(
       groupBackgroundColor: HexColor.fromHex('#F7F8FC'),
     );
-    return Container(
-      color: Colors.white,
-      child: Padding(
-        padding: const EdgeInsets.symmetric(vertical: 30, horizontal: 20),
-        child: AppFlowyBoard(
-          dataController: boardDataController,
-          footerBuilder: (context, columnData) {
-            return AppFlowyGroupFooter(
-              icon: const Icon(Icons.add, size: 20),
-              title: const Text('New'),
-              height: 50,
-              margin: config.groupItemPadding,
-            );
-          },
-          headerBuilder: (context, columnData) {
-            return AppFlowyGroupHeader(
-              icon: const Icon(Icons.lightbulb_circle),
-              title: SizedBox(
-                width: 60,
-                child: TextField(
-                  controller: TextEditingController()
-                    ..text = columnData.headerData.groupName,
-                  onSubmitted: (val) {
-                    boardDataController
-                        .getGroupController(columnData.headerData.groupId)!
-                        .updateGroupName(val);
-                  },
-                ),
+    return AppFlowyBoard(
+        controller: controller,
+        cardBuilder: (context, group, groupItem) {
+          return AppFlowyGroupCard(
+            key: ValueKey(groupItem.id),
+            child: _buildCard(groupItem),
+          );
+        },
+        footerBuilder: (context, columnData) {
+          return AppFlowyGroupFooter(
+            icon: const Icon(Icons.add, size: 20),
+            title: const Text('New'),
+            height: 50,
+            margin: config.groupItemPadding,
+          );
+        },
+        headerBuilder: (context, columnData) {
+          return AppFlowyGroupHeader(
+            icon: const Icon(Icons.lightbulb_circle),
+            title: SizedBox(
+              width: 60,
+              child: TextField(
+                controller: TextEditingController()
+                  ..text = columnData.headerData.groupName,
+                onSubmitted: (val) {
+                  controller
+                      .getGroupController(columnData.headerData.groupId)!
+                      .updateGroupName(val);
+                },
               ),
-              addIcon: const Icon(Icons.add, size: 20),
-              moreIcon: const Icon(Icons.more_horiz, size: 20),
-              height: 50,
-              margin: config.groupItemPadding,
-            );
-          },
-          cardBuilder: (context, column, columnItem) {
-            return AppFlowyGroupItemCard(
-              key: ValueKey(columnItem.id),
-              child: _buildCard(columnItem),
-            );
-          },
-          groupConstraints: const BoxConstraints.tightFor(width: 240),
-          config: AppFlowyBoardConfig(
-            groupBackgroundColor: HexColor.fromHex('#F7F8FC'),
-          ),
-        ),
-      ),
-    );
+            ),
+            addIcon: const Icon(Icons.add, size: 20),
+            moreIcon: const Icon(Icons.more_horiz, size: 20),
+            height: 50,
+            margin: config.groupItemPadding,
+          );
+        },
+        groupConstraints: const BoxConstraints.tightFor(width: 240),
+        config: config);
   }
 
   Widget _buildCard(AppFlowyGroupItem item) {

frontend/app_flowy/packages/appflowy_board/example/lib/single_board_list_example.dart

@@ -9,11 +9,11 @@ class SingleBoardListExample extends StatefulWidget {
 }
 
 class _SingleBoardListExampleState extends State<SingleBoardListExample> {
-  final AppFlowyBoardDataController boardData = AppFlowyBoardDataController();
+  final AppFlowyBoardController boardData = AppFlowyBoardController();
 
   @override
   void initState() {
-    final column = AppFlowyBoardGroupData(
+    final column = AppFlowyGroupData(
       id: "1",
       name: "1",
       items: [
@@ -31,7 +31,7 @@ class _SingleBoardListExampleState extends State<SingleBoardListExample> {
   @override
   Widget build(BuildContext context) {
     return AppFlowyBoard(
-      dataController: boardData,
+      controller: boardData,
       cardBuilder: (context, column, columnItem) {
         return _RowWidget(
             item: columnItem as TextItem, key: ObjectKey(columnItem));