diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart index 8108883c13..a0c4e33a70 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart @@ -89,7 +89,7 @@ class Node extends ChangeNotifier with LinkedListEntry { bool shouldNotifyParent = _attributes['subtype'] != attributes['subtype']; _attributes = composeAttributes(_attributes, attributes) ?? {}; - // Notify the new attributes + // Notifies the new attributes // if attributes contains 'subtype', should notify parent to rebuild node // else, just notify current node. shouldNotifyParent ? parent?.notifyListeners() : notifyListeners(); @@ -137,7 +137,7 @@ class Node extends ChangeNotifier with LinkedListEntry { entry.parent = parent; super.insertAfter(entry); - // Notify the new node. + // Notifies the new node. parent?.notifyListeners(); } @@ -146,7 +146,7 @@ class Node extends ChangeNotifier with LinkedListEntry { entry.parent = parent; super.insertBefore(entry); - // Notify the new node. + // Notifies the new node. parent?.notifyListeners(); } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/editor_state.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/editor_state.dart index 340a8fee07..659e612645 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/editor_state.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/editor_state.dart @@ -11,7 +11,7 @@ import 'package:appflowy_editor/src/undo_manager.dart'; class ApplyOptions { /// This flag indicates that /// whether the transaction should be recorded into - /// the undo stack. + /// the undo stack final bool recordUndo; final bool recordRedo; const ApplyOptions({ @@ -27,9 +27,9 @@ enum CursorUpdateReason { /// The state of the editor. /// -/// The state including: +/// The state includes: /// - The document to render -/// - The state of the selection. +/// - The state of the selection /// /// [EditorState] also includes the services of the editor: /// - Selection service @@ -38,8 +38,8 @@ enum CursorUpdateReason { /// - Input service /// - Toolbar service /// -/// In consideration of collaborative editing. -/// All the mutations should be applied through [Transaction]. +/// In consideration of collaborative editing, +/// all the mutations should be applied through [Transaction]. /// /// Mutating the document with document's API is not recommended. class EditorState { diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart index 9358cb2f2b..1cc1ebfd2e 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart @@ -12,8 +12,8 @@ import 'package:appflowy_editor/src/operation/operation.dart'; import 'package:appflowy_editor/src/operation/transaction.dart'; /// A [TransactionBuilder] is used to build the transaction from the state. -/// It will save make a snapshot of the cursor selection state automatically. -/// The cursor can be resorted if the transaction is undo. +/// It will save a snapshot of the cursor selection state automatically. +/// The cursor can be restored if the transaction is undo. class TransactionBuilder { final List operations = []; EditorState state; @@ -22,24 +22,24 @@ class TransactionBuilder { TransactionBuilder(this.state); - /// Commit the operations to the state + /// Commits the operations to the state commit() { final transaction = finish(); state.apply(transaction); } - /// Insert the nodes at the position of path. + /// Inserts the nodes at the position of path. insertNode(Path path, Node node) { insertNodes(path, [node]); } - /// Insert a sequence of nodes at the position of path. + /// Inserts a sequence of nodes at the position of path. insertNodes(Path path, List nodes) { beforeSelection = state.cursorSelection; add(InsertOperation(path, nodes.map((node) => node.deepClone()).toList())); } - /// Update the attributes of nodes. + /// Updates the attributes of nodes. updateNode(Node node, Attributes attributes) { beforeSelection = state.cursorSelection; @@ -51,7 +51,7 @@ class TransactionBuilder { )); } - /// Delete a node in the document. + /// Deletes a node in the document. deleteNode(Node node) { deleteNodesAtPath(node.path); } @@ -60,8 +60,8 @@ class TransactionBuilder { nodes.forEach(deleteNode); } - /// Delete a sequence of nodes at the path of the document. - /// The length specific the length of the following nodes to delete( + /// Deletes a sequence of nodes at the path of the document. + /// The length specifies the length of the following nodes to delete( /// including the start one). deleteNodesAtPath(Path path, [int length = 1]) { if (path.isEmpty) { @@ -112,7 +112,7 @@ class TransactionBuilder { ); } - /// Insert content at a specified index. + /// Inserts content at a specified index. /// Optionally, you may specify formatting attributes that are applied to the inserted string. /// By default, the formatting attributes before the insert position will be used. insertText(TextNode node, int index, String content, @@ -135,7 +135,7 @@ class TransactionBuilder { Position(path: node.path, offset: index + content.length)); } - /// Assign formatting attributes to a range of text. + /// Assigns formatting attributes to a range of text. formatText(TextNode node, int index, int length, Attributes attributes) { textEdit( node, @@ -145,7 +145,7 @@ class TransactionBuilder { afterSelection = beforeSelection; } - /// Delete length characters starting from index. + /// Deletes length characters starting from index. deleteText(TextNode node, int index, int length) { textEdit( node, @@ -180,7 +180,7 @@ class TransactionBuilder { ); } - /// Add an operation to the transaction. + /// Adds an operation to the transaction. /// This method will merge operations if they are both TextEdits. /// /// Also, this method will transform the path of the operations @@ -209,7 +209,7 @@ class TransactionBuilder { operations.add(op); } - /// Generate a immutable [Transaction] to apply or transmit. + /// Generates a immutable [Transaction] to apply or transmit. Transaction finish() { return Transaction( operations: UnmodifiableListView(operations), diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/selection_service.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/selection_service.dart index 1c7aa48d97..bcce83a0c6 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/selection_service.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/selection_service.dart @@ -455,8 +455,8 @@ class _AppFlowySelectionState extends State final topLimit = size * 0.3; final bottomLimit = size * 0.8; - /// TODO: It is necessary to calculate the relative speed - /// according to the gap and move forward more gently. + // TODO: It is necessary to calculate the relative speed + // according to the gap and move forward more gently. if (rect.top >= bottomLimit) { if (selection.isSingle) { editorState.service.scrollService?.scrollTo(dy + size * 0.2);