Parcourir la source

Added documentation for @interface core.editor.EditorUI.

Aleksander Nowodzinski il y a 9 ans
Parent
commit
e19eb7128f

+ 34 - 0
packages/ckeditor5-core/src/editor/editorui.jsdoc

@@ -0,0 +1,34 @@
+/**
+ * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/**
+ * Minimal interface that is required to successfully bootstrap any editor UI.
+ *
+ * @interface core.editor.EditorUI
+ */
+
+/**
+ * The main (top–most) view of the editor UI.
+ *
+ * @readonly
+ * @member {ui.editorUI.EditorUIView} core.editor.EditorUI#view
+ */
+
+/**
+ * Instance of the {@link ui.ComponentFactory}, a registry used by features
+ * to register and create instance of UI components.
+ *
+ * @readonly
+ * @member {ui.ComponentFactory} core.editor.EditorUI#featureComponents
+ */
+
+/**
+ * Keeps information about editor UI focus and propagates it among
+ * various features and components, unifying them in a uniform
+ * focus group.
+ *
+ * @readonly
+ * @member {utils.FocusTracker} core.editor.EditorUI#focusTracker
+ */

+ 1 - 1
packages/ckeditor5-core/src/editor/standardeditor.js

@@ -54,7 +54,7 @@ export default class StandardEditor extends Editor {
 		 * so every editor class which is meant to work with default features should set this property.
 		 *
 		 * @readonly
-		 * @member {ui.editorUI.EditorUI} core.editor.StandardEditor#ui
+		 * @member {core.editor.EditorUI} core.editor.StandardEditor#ui
 		 */
 	}