8
0
Просмотр исходного кода

Improved documentation of the EditorUI component.

Aleksander Nowodzinski 9 лет назад
Родитель
Сommit
88626c86f5

+ 7 - 2
packages/ckeditor5-ui/src/editorui/boxed/boxededitorui.js

@@ -9,8 +9,13 @@ import EditorUI from '../../../ui/editorui/editorui.js';
 import ControllerCollection from '../../../ui/controllercollection.js';
 
 /**
- * Boxed editor UI. The class representing classic editor interface, which contains of a toolbar and editable are,
- * closed within a box.
+ * The BoxedEditorUI controller class. This class controls an editor interface
+ * consisting of a toolbar and an editable area, enclosed within a box.
+ *
+ *		// An instance of BoxedEditorUI.
+ *		new BoxedEditorUI( editor );
+ *
+ * See {@link ui.editorUI.boxed.BoxedEditorUIView}.
  *
  * @member ui.editorUI.boxed
  * @extends ui.editorUI.EditorUI

+ 5 - 4
packages/ckeditor5-ui/src/editorui/boxed/boxededitoruiview.js

@@ -10,16 +10,17 @@ import uid from '../../../utils/uid.js';
 import Template from '../../template.js';
 
 /**
- * Boxed editor UI view.
+ * The BoxedEditorUIView class. This class represents an editor interface
+ * consisting of a toolbar and an editable area, enclosed within a box.
+ *
+ * See {@link ui.editorUI.boxed.BoxedEditorUI}.
  *
  * @member ui.editorUI.boxed
  * @extends ui.editorUI.EditorUIView
  */
 export default class BoxedEditorUIView extends EditorUIView {
 	/**
-	 * Creates a BoxedEditorUIView instance.
-	 *
-	 * @param {utils.Locale} [locale] The {@link ckeditor5.Editor#locale editor's locale} instance.
+	 * @inheritDoc
 	 */
 	constructor( locale ) {
 		super( locale );

+ 8 - 2
packages/ckeditor5-ui/src/editorui/editorui.js

@@ -15,7 +15,13 @@ import iconManagerModel from '../../../theme/iconmanagermodel.js';
 import mix from '../../utils/mix.js';
 
 /**
- * Base class for the editor main view controllers.
+ * The EditorUI controller class. It's a base class for the editor
+ * main view controllers.
+ *
+ *		// An instance of EditorUI.
+ *		new EditorUI( editor );
+ *
+ * See {@link ui.editorUI.EditorUIView}.
  *
  * @memberOf ui.editorUI
  * @extends ui.Controller
@@ -23,7 +29,7 @@ import mix from '../../utils/mix.js';
  */
 export default class EditorUI extends Controller {
 	/**
-	 * Creates an EditorUI instance.
+	 * Creates an instance of {@link ui.editorUI.EditorUI} class.
 	 *
 	 * @param {ckeditor5.Editor} editor
 	 */

+ 4 - 2
packages/ckeditor5-ui/src/editorui/editoruiview.js

@@ -9,14 +9,16 @@ import View from '../view.js';
 import Template from '../template.js';
 
 /**
- * Base class for the editor main views.
+ * The EditorUIView class. Base class for the editor main views.
+ *
+ * See {@link ui.editorUI.EditorUI}.
  *
  * @memberOf ui.editorUI
  * @extends ui.View
  */
 export default class EditorUIView extends View {
 	/**
-	 * Creates a EditorUIView instance.
+	 * Creates an instance of the EditorUIView class.
 	 *
 	 * @param {utils.Locale} [locale] The {@link ckeditor5.Editor#locale editor's locale} instance.
 	 */