Browse Source

Aligned API docs to recent changes on master.

Piotrek Koszuliński 9 years ago
parent
commit
bb1ff6e4bb

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

@@ -14,25 +14,29 @@ import utils from '../utils.js';
 /**
  * Base class for the editor main view controllers.
  *
- * @memberOf core
- * @class core.editorui.EditorUI
+ * @memberOf core.editorUI
  * @extends core.ui.Controller
  * @mixes core.ObservableMixin
  */
 
 export default class EditorUI extends Controller {
+	/**
+	 * Creates an EditorUI instance.
+	 *
+	 * @param {core.Editor} editor
+	 */
 	constructor( editor ) {
 		super();
 
 		/**
 		 * @readonly
-		 * @member {core.Editor} core.EditorUI#editor
+		 * @member {core.Editor} core.editorUI.EditorUI#editor
 		 */
 		this.editor = editor;
 
 		/**
 		 * @readonly
-		 * @member {core.ui.ComponentFactory} core.EditorUI#featureComponents
+		 * @member {core.ui.ComponentFactory} core.editorUI.EditorUI#featureComponents
 		 */
 		this.featureComponents = new ComponentFactory( editor );
 

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

@@ -10,7 +10,7 @@ import View from '../ui/view.js';
 /**
  * Base class for the editor main views.
  *
- * @class core.editorui.EditorUIView
+ * @memberOf core.editorUI
  * @extends core.ui.View
  */
 
@@ -24,8 +24,7 @@ export default class EditorUIView extends View {
 		 * The element holding elements of the 'body' region.
 		 *
 		 * @private
-		 * @type HTMLElement
-		 * @property _bodyRegionContainer
+		 * @member {HTMLElement} core.editorUI.EditorUIView#_bodyRegionContainer
 		 */
 	}
 

+ 1 - 6
packages/ckeditor5-ui/src/ui/button/button.js

@@ -10,16 +10,11 @@ import Controller from '../controller.js';
 /**
  * The basic button controller class.
  *
- * @class core.ui.button.Button
+ * @memberOf core.ui.button
  * @extends core.ui.Controller
  */
 
 export default class Button extends Controller {
-	/**
-	 * Creates a new button instance.
-	 *
-	 * @method constructor
-	 */
 	constructor( model, view ) {
 		super( model, view );
 

+ 1 - 7
packages/ckeditor5-ui/src/ui/button/buttonview.js

@@ -10,17 +10,11 @@ import View from '../view.js';
 /**
  * The basic button view class.
  *
- * @class core.ui.button.ButtonView
+ * @memberOf core.ui.button
  * @extends core.ui.View
  */
 
 export default class ButtonView extends View {
-	/**
-	 * Creates a new button view instance.
-	 *
-	 * @method constructor
-	 * @param {Model} model
-	 */
 	constructor( model ) {
 		super( model );
 

+ 8 - 4
packages/ckeditor5-ui/src/ui/componentfactory.js

@@ -14,26 +14,30 @@ import CKEditorError from '../ckeditorerror.js';
  * components can be later instantiated by providing the name of the component. The model is shared between all
  * instances of that component and has to be provided upon registering its factory.
  *
- * The main use case for the component factory is the {@link core.EditorUI#featureComponents} factory.
+ * The main use case for the component factory is the {@link core.editorUI.EditorUI#featureComponents} factory.
  *
- * @class core.ui.ComponentFactory
+ * @memberOf core.ui
  */
 
 export default class ComponentFactory {
 	/**
+	 * Creates ComponentFactory instance.
+	 *
 	 * @constructor
 	 * @param {core.Editor} editor The editor instance.
 	 */
 	constructor( editor ) {
 		/**
 		 * @readonly
-		 * @type {core.Editor}
+		 * @member {core.Editor} core.ui.ComponentFactory#editor
 		 */
 		this.editor = editor;
 
 		/**
+		 * Registered component factories.
+		 *
 		 * @private
-		 * @type {Map}
+		 * @member {Map} core.ui.ComponentFactory#_components
 		 */
 		this._components = new Map();
 	}

+ 1 - 1
packages/ckeditor5-ui/src/ui/region.js

@@ -29,7 +29,7 @@ export default class Region {
 		/**
 		 * Views which belong to the region.
 		 *
-		 * @member {Collection} core.ui.Region#views
+		 * @member {core.Collection} core.ui.Region#views
 		 */
 		this.views = new Collection();
 

+ 1 - 6
packages/ckeditor5-ui/src/ui/toolbar/toolbar.js

@@ -11,16 +11,11 @@ import ControllerCollection from '../controllercollection.js';
 /**
  * The basic toolbar controller class.
  *
- * @class core.ui.toolbar.Toolbar
+ * @memberOf core.ui.toolbar
  * @extends core.ui.Controller
  */
 
 export default class Toolbar extends Controller {
-	/**
-	 * Creates a new toolbar instance.
-	 *
-	 * @method constructor
-	 */
 	constructor( model, view ) {
 		super( model, view );
 

+ 1 - 7
packages/ckeditor5-ui/src/ui/toolbar/toolbarview.js

@@ -10,17 +10,11 @@ import View from '../view.js';
 /**
  * The basic toolbar view class.
  *
- * @class core.ui.toolbar.ToolbarView
+ * @memberOf core.ui.toolbar
  * @extends core.ui.View
  */
 
 export default class ToolbarView extends View {
-	/**
-	 * Creates a new toolbar view instance.
-	 *
-	 * @method constructor
-	 * @param {Model} model
-	 */
 	constructor( model ) {
 		super( model );