From 88f73bfbd4b6173b21bd88be606371bee7045af3 Mon Sep 17 00:00:00 2001
From: "Lucas.Xu" <lucas.xu@appflowy.io>
Date: Wed, 13 Jul 2022 10:28:52 +0800
Subject: [PATCH] chore: add comment to RenderPlugins

---
 .../packages/flowy_editor/lib/render/render_plugins.dart      | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/frontend/app_flowy/packages/flowy_editor/lib/render/render_plugins.dart b/frontend/app_flowy/packages/flowy_editor/lib/render/render_plugins.dart
index 84e3d894b7..49929f17e1 100644
--- a/frontend/app_flowy/packages/flowy_editor/lib/render/render_plugins.dart
+++ b/frontend/app_flowy/packages/flowy_editor/lib/render/render_plugins.dart
@@ -16,10 +16,14 @@ class RenderPlugins {
   // unused
   // Map<String, NodeBuilder> nodeBuilders = {};
 
+  /// register plugin to render specified [name].
+  /// [name] should be correspond to the [type] in [Node].
+  /// [name] could be empty.
   void register(String name, NodeWidgetBuilderF builder) {
     nodeWidgetBuilders[name] = builder;
   }
 
+  /// unRegister plugin with specified [name].
   void unRegister(String name) {
     nodeWidgetBuilders.removeWhere((key, _) => key == name);
   }