Explorar o código

Changed UI class names in docs from camel-case to separate words.

Aleksander Nowodzinski %!s(int64=9) %!d(string=hai) anos
pai
achega
6fcc0c578f

+ 3 - 3
packages/ckeditor5-ui/src/bindings/stickytoolbar.js

@@ -9,7 +9,7 @@ import ToolbarBindingsMixin from './toolbarbindingsmixin.js';
 import BaseStickyToolbar from '../toolbar/sticky/stickytoolbar.js';
 import BaseStickyToolbar from '../toolbar/sticky/stickytoolbar.js';
 
 
 /**
 /**
- * The editor StickyToolbar controller class.
+ * The editor sticky toolbar controller class.
  *
  *
  * See {@link ui.stickyToolbar.StickyToolbar}.
  * See {@link ui.stickyToolbar.StickyToolbar}.
  *
  *
@@ -20,8 +20,8 @@ export default class StickyToolbar extends BaseStickyToolbar {
 	/**
 	/**
 	 * Creates an instance of {@link ui.bindings.StickyToolbar} class.
 	 * Creates an instance of {@link ui.bindings.StickyToolbar} class.
 	 *
 	 *
-	 * @param {ui.stickyToolbar.StickyToolbarModel} model Model of this StickyToolbar.
-	 * @param {ui.View} view View of this StickyToolbar.
+	 * @param {ui.stickyToolbar.StickyToolbarModel} model Model of this sticky toolbar.
+	 * @param {ui.View} view View of this sticky toolbar.
 	 * @param {ckeditor5.Editor} editor
 	 * @param {ckeditor5.Editor} editor
 	 */
 	 */
 	constructor( model, view, editor ) {
 	constructor( model, view, editor ) {

+ 2 - 0
packages/ckeditor5-ui/src/bindings/toolbarbindingsmixin.js

@@ -8,6 +8,8 @@
 /**
 /**
  * Mixin that injects the common Toolbar–like bindings.
  * Mixin that injects the common Toolbar–like bindings.
  *
  *
+ * See {@link ui.bindings.Toolbar}.
+ *
  * @mixin ui.bindings.ToolbarBindingsMixin
  * @mixin ui.bindings.ToolbarBindingsMixin
  */
  */
 const ToolbarBindingsMixin = {
 const ToolbarBindingsMixin = {

+ 3 - 3
packages/ckeditor5-ui/src/editableui/editableui.js

@@ -8,7 +8,7 @@
 import Controller from '../controller.js';
 import Controller from '../controller.js';
 
 
 /**
 /**
- * The EditableUI controller class. It glues the engine editable
+ * The editable UI controller class. It glues the engine editable
  * {@link engine.view.RootEditableElement} with the UI.
  * {@link engine.view.RootEditableElement} with the UI.
  *
  *
  *		// An instance of EditableUI.
  *		// An instance of EditableUI.
@@ -24,8 +24,8 @@ export default class EditableUI extends Controller {
 	 * Creates an instance of {@link ui.editableUI.EditableUI} class.
 	 * Creates an instance of {@link ui.editableUI.EditableUI} class.
 	 *
 	 *
 	 * @param {ckeditor5.Editor} editor The editor instance.
 	 * @param {ckeditor5.Editor} editor The editor instance.
-	 * @param {engine.view.RootEditableElement} editable The editable element in the engine.
-	 * @param {ui.View} [view] An instance of EditableUIView instance.
+	 * @param {engine.view.RootEditableElement} editable The editable element (in the engine).
+	 * @param {ui.View} [view] An instance of EditableUIView.
 	 */
 	 */
 	constructor( editor, editable, view ) {
 	constructor( editor, editable, view ) {
 		super( editable, view );
 		super( editable, view );

+ 5 - 5
packages/ckeditor5-ui/src/editableui/editableuiview.js

@@ -9,7 +9,7 @@ import View from '../view.js';
 import Template from '../template.js';
 import Template from '../template.js';
 
 
 /**
 /**
- * The EditableUIView class.
+ * The editable UI view class.
  *
  *
  * See {@link ui.editableUI.EditableUI}.
  * See {@link ui.editableUI.EditableUI}.
  *
  *
@@ -18,7 +18,7 @@ import Template from '../template.js';
  */
  */
 export default class EditableUIView extends View {
 export default class EditableUIView extends View {
 	/**
 	/**
-	 * Creates an instance of the EditableUIView class.
+	 * Creates an instance of {@link ui.editableUI.EditableUIView} class.
 	 *
 	 *
 	 * @param {utils.Locale} [locale] The {@link ckeditor5.Editor#locale editor's locale} instance.
 	 * @param {utils.Locale} [locale] The {@link ckeditor5.Editor#locale editor's locale} instance.
 	 * @param {HTMLElement} [editableElement] The editable element. If not specified, this view
 	 * @param {HTMLElement} [editableElement] The editable element. If not specified, this view
@@ -52,7 +52,7 @@ export default class EditableUIView extends View {
 		 */
 		 */
 
 
 		/**
 		/**
-		 * Model of this EditableUIView.
+		 * Model of this editable UI view.
 		 *
 		 *
 		 * @member {ui.editableUI.EditableUIViewModel} ui.editableUI.EditableUIView#model
 		 * @member {ui.editableUI.EditableUIViewModel} ui.editableUI.EditableUIView#model
 		 */
 		 */
@@ -80,7 +80,7 @@ export default class EditableUIView extends View {
 }
 }
 
 
 /**
 /**
- * The EditableUIView {@link ui.Model} interface.
+ * The editable UI view {@link ui.Model} interface.
  *
  *
  * @memberOf ui.editableUI
  * @memberOf ui.editableUI
  * @interface ui.editableUI.EditableUIViewModel
  * @interface ui.editableUI.EditableUIViewModel
@@ -99,7 +99,7 @@ export default class EditableUIView extends View {
  */
  */
 
 
 /**
 /**
- * The name of the EditableUIView.
+ * The name of the editable UI view.
  *
  *
  * @member {String} ui.editableUI.EditableUIViewModel#name
  * @member {String} ui.editableUI.EditableUIViewModel#name
  */
  */

+ 1 - 1
packages/ckeditor5-ui/src/editableui/inline/inlineeditableuiview.js

@@ -9,7 +9,7 @@ import EditableUIView from '../../editableui/editableuiview.js';
 import Template from '../../template.js';
 import Template from '../../template.js';
 
 
 /**
 /**
- * The InlineEditableUIView class implementing an inline {@link ui.editableUI.EditableUIView}.
+ * The inline editable UI class implementing an inline {@link ui.editableUI.EditableUIView}.
  *
  *
  * See {@link ui.editableUI.EditableUI}, {@link ui.editableUI.EditableUIView}.
  * See {@link ui.editableUI.EditableUI}, {@link ui.editableUI.EditableUIView}.
  *
  *

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

@@ -9,7 +9,7 @@ import EditorUI from '../../../ui/editorui/editorui.js';
 import ControllerCollection from '../../../ui/controllercollection.js';
 import ControllerCollection from '../../../ui/controllercollection.js';
 
 
 /**
 /**
- * The BoxedEditorUI controller class. This class controls an editor interface
+ * The boxed editor UI controller class. This class controls an editor interface
  * consisting of a toolbar and an editable area, enclosed within a box.
  * consisting of a toolbar and an editable area, enclosed within a box.
  *
  *
  *		// An instance of BoxedEditorUI.
  *		// An instance of BoxedEditorUI.
@@ -22,7 +22,7 @@ import ControllerCollection from '../../../ui/controllercollection.js';
  */
  */
 export default class BoxedEditorUI extends EditorUI {
 export default class BoxedEditorUI extends EditorUI {
 	/**
 	/**
-	 * Creates a BoxedEditorUI instance.
+	 * Creates a boxed editor UI instance.
 	 *
 	 *
 	 * @param {ckeditor5.Editor} editor
 	 * @param {ckeditor5.Editor} editor
 	 */
 	 */

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

@@ -10,7 +10,7 @@ import uid from '../../../utils/uid.js';
 import Template from '../../template.js';
 import Template from '../../template.js';
 
 
 /**
 /**
- * The BoxedEditorUIView class. This class represents an editor interface
+ * The boxed editor UI view class. This class represents an editor interface
  * consisting of a toolbar and an editable area, enclosed within a box.
  * consisting of a toolbar and an editable area, enclosed within a box.
  *
  *
  * See {@link ui.editorUI.boxed.BoxedEditorUI}.
  * See {@link ui.editorUI.boxed.BoxedEditorUI}.

+ 3 - 3
packages/ckeditor5-ui/src/editorui/editorui.js

@@ -15,13 +15,13 @@ import iconManagerModel from '../../../theme/iconmanagermodel.js';
 import mix from '../../utils/mix.js';
 import mix from '../../utils/mix.js';
 
 
 /**
 /**
- * The EditorUI controller class. It's a base class for the editor
+ * The editor UI controller class. It's a base class for the editor
  * main view controllers.
  * main view controllers.
  *
  *
  *		// An instance of EditorUI.
  *		// An instance of EditorUI.
  *		new EditorUI( editor );
  *		new EditorUI( editor );
  *
  *
- * See {@link ui.editorUI.EditorUIView}.
+ * See {@link ui.editorUI.EditorUIView}, {@link ui.iconManager.IconManager}.
  *
  *
  * @memberOf ui.editorUI
  * @memberOf ui.editorUI
  * @extends ui.Controller
  * @extends ui.Controller
@@ -63,7 +63,7 @@ export default class EditorUI extends Controller {
 	}
 	}
 
 
 	/**
 	/**
-	 * Adds IconManager into DOM.
+	 * Injects the {@link ui.iconManager.IconManager} into DOM.
 	 *
 	 *
 	 * @protected
 	 * @protected
 	 */
 	 */

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

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

+ 2 - 2
packages/ckeditor5-ui/src/iconmanager/iconmanager.js

@@ -8,7 +8,7 @@
 import Controller from '../controller.js';
 import Controller from '../controller.js';
 
 
 /**
 /**
- * The IconManager controller class. It provides SVG icons, which then can
+ * The icon manager controller class. It provides SVG icons, which then can
  * be used by {@link ui.icon.Icon} component and similar.
  * be used by {@link ui.icon.Icon} component and similar.
  *
  *
  *		const model = new Model( {
  *		const model = new Model( {
@@ -39,7 +39,7 @@ export default class IconManager extends Controller {
 }
 }
 
 
 /**
 /**
- * The IconManager component {@link ui.Model} interface.
+ * The icon manager component {@link ui.Model} interface.
  *
  *
  * @memberOf ui.iconManager
  * @memberOf ui.iconManager
  * @interface ui.iconManager.IconManagerModel
  * @interface ui.iconManager.IconManagerModel

+ 3 - 3
packages/ckeditor5-ui/src/iconmanager/iconmanagerview.js

@@ -9,7 +9,7 @@ import View from '../view.js';
 import Template from '../template.js';
 import Template from '../template.js';
 
 
 /**
 /**
- * The IconManagerView class.
+ * The icon manager view class.
  *
  *
  * See {@link ui.iconManager.IconManager}.
  * See {@link ui.iconManager.IconManager}.
  *
  *
@@ -29,7 +29,7 @@ export default class IconManagerView extends View {
 		} );
 		} );
 
 
 		/**
 		/**
-		 * Model of this IconManagerView.
+		 * Model of this icon manager view.
 		 *
 		 *
 		 * @member {ui.iconManager.IconManagerViewModel} ui.iconManager.IconManagerView#model
 		 * @member {ui.iconManager.IconManagerViewModel} ui.iconManager.IconManagerView#model
 		 */
 		 */
@@ -43,7 +43,7 @@ export default class IconManagerView extends View {
 }
 }
 
 
 /**
 /**
- * The IconManagerView {@link ui.Model} interface.
+ * The icon manager view {@link ui.Model} interface.
  *
  *
  * @memberOf ui.iconManager
  * @memberOf ui.iconManager
  * @interface ui.iconManager.IconManagerViewModel
  * @interface ui.iconManager.IconManagerViewModel