8
0
Quellcode durchsuchen

Documentation: fix @property tag with @type.

Maciej Gołaszewski vor 9 Jahren
Ursprung
Commit
317cadd17c

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

@@ -43,7 +43,7 @@ export default class CKEditorError extends Error {
 		/**
 		 * The additional error data passed to the constructor.
 		 *
-		 * @property {Object} data
+		 * @type {Object}
 		 */
 		this.data = data;
 	}

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

@@ -37,7 +37,7 @@ export default class Collection {
 		 * The internal list of items in the collection.
 		 *
 		 * @private
-		 * @property {Object[]}
+		 * @type {Object[]}
 		 */
 		this._items = [];
 
@@ -45,7 +45,7 @@ export default class Collection {
 		 * The internal map of items in the collection.
 		 *
 		 * @private
-		 * @property {Map}
+		 * @type {Map}
 		 */
 		this._itemMap = new Map();
 
@@ -53,7 +53,7 @@ export default class Collection {
 		 * The name of the property which is considered to identify an item.
 		 *
 		 * @private
-		 * @property {String}
+		 * @type {String}
 		 */
 		this._idProperty = options && options.idProperty || 'id';
 	}

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

@@ -29,7 +29,7 @@ export default class Editable extends Controller {
 		/**
 		 * Whether the editable is in read-write or read-only mode.
 		 *
-		 * @property {Boolean} isEditable
+		 * @type {Boolean}
 		 */
 		this.set( 'isEditable', true );
 
@@ -37,7 +37,7 @@ export default class Editable extends Controller {
 		 * Whether the editable is focused.
 		 *
 		 * @readonly
-		 * @property {Boolean} isFocused
+		 * @type {Boolean}
 		 */
 		this.set( 'isFocused', false );
 
@@ -50,7 +50,7 @@ export default class Editable extends Controller {
 	 * The model for the editable view.
 	 *
 	 * @readonly
-	 * @property {core.ui.Model} viewModel
+	 * @type {core.ui.Model}
 	 */
 	get viewModel() {
 		if ( this._viewModel ) {

+ 1 - 1
packages/ckeditor5-ui/src/editable/editableview.js

@@ -13,7 +13,7 @@ export default class EditableView extends View {
 	 * The element which is the main editable element (usually the one with `contentEditable="true"`).
 	 *
 	 * @readonly
-	 * @property {HTMLElement} editableElement
+	 * @type {HTMLElement}
 	 */
 
 	setEditableElement( editableElement ) {

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

@@ -23,7 +23,7 @@ export default class EditorUI extends Controller {
 
 		/**
 		 * @readonly
-		 * @property {core.Editor}
+		 * @type {core.Editor}
 		 */
 		this.editor = editor;
 	}

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

@@ -262,7 +262,7 @@ function initObservable( observable ) {
 	// The internal hash containing the observable's state.
 	//
 	// @private
-	// @property {Map} _attributes
+	// @type {Map}
 	Object.defineProperty( observable, attributesSymbol, {
 		value: new Map()
 	} );
@@ -311,7 +311,7 @@ function initObservable( observable ) {
 	//			} )
 	//
 	// @private
-	// @property {Map} _boundObservables
+	// @type {Map}
 	Object.defineProperty( observable, boundObservablesSymbol, {
 		value: new Map()
 	} );
@@ -341,7 +341,7 @@ function initObservable( observable ) {
 	//			} )
 	//
 	// @private
-	// @property {Map} _boundAttributes
+	// @type {Map}
 	Object.defineProperty( observable, boundAttributesSymbol, {
 		value: new Map()
 	} );

+ 4 - 4
packages/ckeditor5-ui/src/ui/controller.js

@@ -29,21 +29,21 @@ export default class Controller {
 		/**
 		 * Model of this controller.
 		 *
-		 * @property {Model}
+		 * @type {Model}
 		 */
 		this.model = model || null;
 
 		/**
 		 * Set `true` after {@link #init}.
 		 *
-		 * @property {Boolean}
+		 * @type {Boolean}
 		 */
 		this.ready = false;
 
 		/**
 		 * View of this controller.
 		 *
-		 * @property {View}
+		 * @type {View}
 		 */
 		this.view = view || null;
 
@@ -51,7 +51,7 @@ export default class Controller {
 		 * A collection of {@link ControllerCollection} instances containing
 		 * child controllers.
 		 *
-		 * @property {Collection}
+		 * @type {Collection}
 		 */
 		this.collections = new Collection( {
 			idProperty: 'name'

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

@@ -35,14 +35,14 @@ export default class ControllerCollection extends Collection {
 		/**
 		 * Name of this collection.
 		 *
-		 * @property {String}
+		 * @type {String}
 		 */
 		this.name = name;
 
 		/**
 		 * Parent controller of this collection.
 		 *
-		 * @property {Controller}
+		 * @type {Controller}
 		 */
 		this.parent = null;
 	}

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

@@ -38,7 +38,7 @@ extend( ProxyEmitter.prototype, EmitterMixin, {
 	 * Collection of native DOM listeners.
 	 *
 	 * @private
-	 * @property {Object} _domListeners
+	 * @type {Object}
 	 */
 
 	/**

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

@@ -25,21 +25,21 @@ export default class Region {
 		/**
 		 * The name of the region.
 		 *
-		 * @property {String}
+		 * @type {String}
 		 */
 		this.name = name;
 
 		/**
 		 * Views which belong to the region.
 		 *
-		 * @property {Collection}
+		 * @type {Collection}
 		 */
 		this.views = new Collection();
 
 		/**
 		 * Element of this region (see {@link #init}).
 		 *
-		 * @property {HTMLElement}
+		 * @type {HTMLElement}
 		 */
 		this.element = null;
 	}

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

@@ -26,7 +26,7 @@ export default class Template {
 		/**
 		 * Definition of this template.
 		 *
-		 * @property {TemplateDefinition}
+		 * @type {TemplateDefinition}
 		 */
 		this.definition = def;
 	}

+ 6 - 6
packages/ckeditor5-ui/src/ui/view.js

@@ -34,14 +34,14 @@ export default class View {
 		/**
 		 * Model of this view.
 		 *
-		 * @property {Model}
+		 * @type {Model}
 		 */
 		this.model = model || null;
 
 		/**
 		 * Regions of this view. See {@link #register}.
 		 *
-		 * @property {Collection}
+		 * @type {Collection}
 		 */
 		this.regions = new Collection( {
 			idProperty: 'name'
@@ -50,7 +50,7 @@ export default class View {
 		/**
 		 * Template of this view.
 		 *
-		 * @property {Object}
+		 * @type {Object}
 		 */
 		this.template = null;
 
@@ -58,7 +58,7 @@ export default class View {
 		 * Region selectors of this view. See {@link #register}.
 		 *
 		 * @private
-		 * @property {Object}
+		 * @type {Object}
 		 */
 		this._regionsSelectors = {};
 
@@ -66,7 +66,7 @@ export default class View {
 		 * Element of this view.
 		 *
 		 * @private
-		 * @property {HTMLElement}
+		 * @type {HTMLElement}
 		 */
 		this._element = null;
 
@@ -74,7 +74,7 @@ export default class View {
 		 * An instance of Template to generate {@link #_el}.
 		 *
 		 * @private
-		 * @property {Template}
+		 * @type {Template}
 		 */
 		this._template = null;
 	}