Ver código fonte

Docs: fixed tags usage for getters.

Szymon Cofalik 9 anos atrás
pai
commit
13e7c0e26d

+ 1 - 1
packages/ckeditor5-engine/src/collection.js

@@ -58,7 +58,7 @@ export default class Collection {
 	/**
 	 * The number of items available in the collection.
 	 *
-	 * @property length
+	 * @type {Number}
 	 */
 	get length() {
 		return this._items.length;

+ 1 - 1
packages/ckeditor5-engine/src/command/attributecommand.js

@@ -41,7 +41,7 @@ export default class AttributeCommand extends Command {
 	 * Flag indicating whether command is active. For collapsed selection it means that typed characters will have
 	 * the attribute set. For range selection it means that all nodes inside have the attribute applied.
 	 *
-	 * @returns {Boolean}
+	 * @type {Boolean}
 	 */
 	get value() {
 		return this.editor.document.selection.hasAttribute( this.attributeKey );

+ 4 - 4
packages/ckeditor5-engine/src/treemodel/node.js

@@ -49,7 +49,7 @@ export default class Node {
 	 * Depth of the node, which equals to total number of its parents.
 	 *
 	 * @readonly
-	 * @member {Number} core.treeModel.Node#depth
+	 * @type {Number}
 	 */
 	get depth() {
 		let depth = 0;
@@ -68,7 +68,7 @@ export default class Node {
 	 * Nodes next sibling or `null` if it is the last child.
 	 *
 	 * @readonly
-	 * @member {core.treeModel.Node|null} core.treeModel.Node#nextSibling
+	 * @type {core.treeModel.Node|null}
 	 */
 	get nextSibling() {
 		const index = this.getIndex();
@@ -80,7 +80,7 @@ export default class Node {
 	 * Nodes previous sibling or null if it is the last child.
 	 *
 	 * @readonly
-	 * @member {core.treeModel.Node|null} core.treeModel.Node#previousSibling
+	 * @type {core.treeModel.Node|null}
 	 */
 	get previousSibling() {
 		const index = this.getIndex();
@@ -92,7 +92,7 @@ export default class Node {
 	 * The top parent for the node. If node has no parent it is the root itself.
 	 *
 	 * @readonly
-	 * @member {Number} core.treeModel.Node#root
+	 * @type {Number}
 	 */
 	get root() {
 		let root = this;

+ 0 - 3
packages/ckeditor5-engine/src/treemodel/operation/moveoperation.js

@@ -51,9 +51,6 @@ export default class MoveOperation extends Operation {
 		this.targetPosition = Position.createFromPosition( targetPosition );
 	}
 
-	/**
-	 * @see core.treeModel.operation.Operation#type
-	 */
 	get type() {
 		return 'move';
 	}

+ 0 - 6
packages/ckeditor5-engine/src/treemodel/operation/reinsertoperation.js

@@ -28,16 +28,10 @@ export default class ReinsertOperation extends MoveOperation {
 		return new RemoveOperation( this.targetPosition, this.howMany, this.baseVersion + 1 );
 	}
 
-	/**
-	 * @see core.treeModel.operation.Operation#type
-	 */
 	get type() {
 		return 'reinsert';
 	}
 
-	/**
-	 * @see core.treeModel.operation.MoveOperation#isSticky
-	 */
 	get isSticky() {
 		return false;
 	}

+ 0 - 6
packages/ckeditor5-engine/src/treemodel/operation/removeoperation.js

@@ -31,16 +31,10 @@ export default class RemoveOperation extends MoveOperation {
 		super( position, howMany, graveyardPosition, baseVersion );
 	}
 
-	/**
-	 * @see core.treeModel.operation.Operation#type
-	 */
 	get type() {
 		return 'remove';
 	}
 
-	/**
-	 * @see core.treeModel.operation.MoveOperation#isSticky
-	 */
 	get isSticky() {
 		return false;
 	}

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/range.js

@@ -52,7 +52,7 @@ export default class Range {
 	/**
 	 * Returns whether this range is flat, that is if start position and end position are in the same parent.
 	 *
-	 * @returns {Boolean}
+	 * @type {Boolean}
 	 */
 	get isFlat() {
 		return this.start.parent === this.end.parent;