瀏覽代碼

chore: add comment to RenderPlugins

Lucas.Xu 2 年之前
父節點
當前提交
88f73bfbd4
共有 1 個文件被更改,包括 4 次插入0 次删除
  1. 4 0
      frontend/app_flowy/packages/flowy_editor/lib/render/render_plugins.dart

+ 4 - 0
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);
   }