Explorar o código

chore: add comment to RenderPlugins

Lucas.Xu %!s(int64=2) %!d(string=hai) anos
pai
achega
88f73bfbd4

+ 4 - 0
frontend/app_flowy/packages/flowy_editor/lib/render/render_plugins.dart

@@ -16,10 +16,14 @@ class RenderPlugins {
   // unused
   // unused
   // Map<String, NodeBuilder> nodeBuilders = {};
   // 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) {
   void register(String name, NodeWidgetBuilderF builder) {
     nodeWidgetBuilders[name] = builder;
     nodeWidgetBuilders[name] = builder;
   }
   }
 
 
+  /// unRegister plugin with specified [name].
   void unRegister(String name) {
   void unRegister(String name) {
     nodeWidgetBuilders.removeWhere((key, _) => key == name);
     nodeWidgetBuilders.removeWhere((key, _) => key == name);
   }
   }