Selaa lähdekoodia

Docs: Documentation for core.Feature.

Szymon Cofalik 9 vuotta sitten
vanhempi
sitoutus
bc7079f27e
1 muutettua tiedostoa jossa 11 lisäystä ja 1 poistoa
  1. 11 1
      packages/ckeditor5-engine/src/feature.js

+ 11 - 1
packages/ckeditor5-engine/src/feature.js

@@ -8,7 +8,14 @@
 import Plugin from './plugin.js';
 
 /**
- * The base class for CKEditor feature classes.
+ * The base class for CKEditor feature classes. Features are main way to enhance CKEditor abilities with tools,
+ * utilities, services and components.
+ *
+ * The main responsibilities for Feature are:
+ * * setting required dependencies (see {@link core.Plugin#requires},
+ * * configuring, instantiating and registering commands to editor,
+ * * registering converters to editor (if the feature operates on Tree Model),
+ * * setting and registering UI components (if the feature uses it).
  *
  * @class core.Feature
  */
@@ -23,5 +30,8 @@ export default class Feature extends Plugin {
 		super( editor );
 	}
 
+	/**
+	 * Initializes the feature. Should be overwritten by child classes.
+	 */
 	init() {}
 }