Browse Source

Fix documentation for classes.

Maciej Gołaszewski 9 years ago
parent
commit
ad0a98ba7d
22 changed files with 118 additions and 142 deletions
  1. 1 3
      packages/ckeditor5-engine/src/dataprocessor/basichtmlwriter.js
  2. 7 8
      packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js
  3. 8 11
      packages/ckeditor5-engine/src/editable/editable.js
  4. 6 3
      packages/ckeditor5-engine/src/editable/editableview.js
  5. 7 14
      packages/ckeditor5-engine/src/treecontroller/mapper.js
  6. 2 2
      packages/ckeditor5-engine/src/treemodel/delta/attributedelta.js
  7. 6 7
      packages/ckeditor5-engine/src/treemodel/delta/delta.js
  8. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/insertdelta.js
  9. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/mergedelta.js
  10. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/movedelta.js
  11. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/removedelta.js
  12. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/splitdelta.js
  13. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/unwrapdelta.js
  14. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/weakinsertdelta.js
  15. 1 1
      packages/ckeditor5-engine/src/treemodel/delta/wrapdelta.js
  16. 24 28
      packages/ckeditor5-engine/src/treemodel/operation/attributeoperation.js
  17. 12 15
      packages/ckeditor5-engine/src/treemodel/operation/insertoperation.js
  18. 13 17
      packages/ckeditor5-engine/src/treemodel/operation/moveoperation.js
  19. 2 4
      packages/ckeditor5-engine/src/treemodel/operation/nooperation.js
  20. 10 10
      packages/ckeditor5-engine/src/treemodel/operation/operation.js
  21. 2 3
      packages/ckeditor5-engine/src/treemodel/operation/reinsertoperation.js
  22. 10 9
      packages/ckeditor5-engine/src/treemodel/operation/removeoperation.js

+ 1 - 3
packages/ckeditor5-engine/src/dataprocessor/basichtmlwriter.js

@@ -6,18 +6,16 @@
 'use strict';
 
 /**
- * @classdesc
  * Basic HTML writer, it uses the native `innerHTML` property for basic conversion
  * from DocumentFragment to an HTML string.
  *
- * @class core.dataProcessor.BasicHtmlWriter
+ * @memberOf core.dataProcessor
  * @implements core.dataProcessor.HtmlWriter
  */
 export default class BasicHtmlWriter {
 	/**
 	 * Returns HTML string created from DocumentFragment.
 	 *
-	 * @method core.dataProcessor.BasicHtmlWriter#getHtml
 	 * @param {DocumentFragment} fragment
 	 * @returns {String}
 	 */

+ 7 - 8
packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js

@@ -8,31 +8,30 @@
 import BasicHtmlWriter from './basichtmlwriter.js';
 
 /**
- * Creates a new instance of the HtmlDataProcessor class.
- *
- * @classdesc HtmlDataProcessor class.
+ * HtmlDataProcessor class.
  * This data processor implementation uses HTML as input/output data.
  *
- * @class core.dataProcessor.HtmlDataProcessor
+ * @memberOf core.dataProcessor
  * @implements core.dataProcessor.DataProcessor
  */
 export default class HtmlDataProcessor {
+	/**
+	 * Creates a new instance of the HtmlDataProcessor class.
+	 */
 	constructor() {
 		/**
 		 * DOMParser instance used to parse HTML string to HTMLDocument.
 		 *
-		 * @member core.dataProcessor.HtmlDataProcessor#_domParser
 		 * @private
-		 * @type {DOMParser}
+		 * @member {DOMParser} core.dataProcessor.HtmlDataProcessor#_domParser
 		 */
 		this._domParser = new DOMParser();
 
 		/**
 		 * BasicHtmlWriter instance used to convert DOM elements to HTML string.
 		 *
-		 * @member core.dataProcessor.HtmlDataProcessor#_htmlWriter
 		 * @private
-		 * @type {core.dataProcessor.BasicHtmlWriter}
+		 * @member {core.dataProcessor.BasicHtmlWriter} core.dataProcessor.HtmlDataProcessor#_htmlWriter
 		 */
 		this._htmlWriter = new BasicHtmlWriter();
 	}

+ 8 - 11
packages/ckeditor5-engine/src/editable/editable.js

@@ -11,14 +11,16 @@ import utils from '../utils.js';
 import ObservableMixin from '../observablemixin.js';
 
 /**
- * Creates a new instance of the Editable class.
- *
- * @class core.editable.Editable
+ * @memberOf core.editable
  * @extends core.ui.Controller
  * @mixins core.ObservableMixin
- * @param editor
  */
 export default class Editable extends Controller {
+	/**
+	 * Creates a new instance of the Editable class.
+	 *
+	 * @param editor
+	 */
 	constructor( editor ) {
 		super();
 
@@ -27,17 +29,15 @@ export default class Editable extends Controller {
 		/**
 		 * Whether the editable is in read-write or read-only mode.
 		 *
-		 * @member core.editable.Editable#isEditable
-		 * @type {Boolean}
+		 * @member {Boolean} core.editable.Editable#isEditable
 		 */
 		this.set( 'isEditable', true );
 
 		/**
 		 * Whether the editable is focused.
 		 *
-		 * @member core.editable.Editable#isFocused
 		 * @readonly
-		 * @type {Boolean}
+		 * @member {Boolean} core.editable.Editable#isFocused
 		 */
 		this.set( 'isFocused', false );
 	}
@@ -47,7 +47,6 @@ export default class Editable extends Controller {
 	 *
 	 * @readonly
 	 * @type {core.ui.Model}
-	 * @member core.editable.Editable#_viewModel
 	 */
 	get viewModel() {
 		if ( this._viewModel ) {
@@ -68,7 +67,6 @@ export default class Editable extends Controller {
 	/**
 	 * Temporary implementation (waiting for integration with the data model).
 	 *
-	 * @method core.editable.Editable#setData
 	 * @param {String} data HTML to be loaded.
 	 */
 	setData( data ) {
@@ -78,7 +76,6 @@ export default class Editable extends Controller {
 	/**
 	 * Temporary implementation (waiting for integration with the data model).
 	 *
-	 * @method core.editable.Editable#getData
 	 * @returns {String} HTML string.
 	 */
 	getData() {

+ 6 - 3
packages/ckeditor5-engine/src/editable/editableview.js

@@ -9,16 +9,19 @@ import View from '../ui/view.js';
 import CKEditorError from '../ckeditorerror.js';
 
 /**
- * @class core.editable.EditableView
+ * @memberOf core.editable
  * @extends core.ui.View
  */
 export default class EditableView extends View {
 	/**
 	 * The element which is the main editable element (usually the one with `contentEditable="true"`).
 	 *
-	 * @member core.editable.EditableView#editableElement
 	 * @readonly
-	 * @type {HTMLElement}
+	 * @member {HTMLElement} core.editable.EditableView#editableElement
+	 */
+
+	/**
+	 * @param {HTMLElement} editableElement
 	 */
 	setEditableElement( editableElement ) {
 		const bind = this.attributeBinder;

+ 7 - 14
packages/ckeditor5-engine/src/treecontroller/mapper.js

@@ -10,23 +10,23 @@ import ViewPosition from '../treeview/position.js';
 import ViewText from '../treeview/text.js';
 
 /**
- * Creates an instance of the mapper.
- *
- * @classdesc
  * Maps elements and positions between {@link core.treeView.TreeView TreeView} and {@link core.treeModel TreeModel}.
  *
  * Mapper use binded elements to find corresponding elements and positions, so, to get proper results,
  * all Tree Model elements should be {@link core.treeController.Mapper#bindElements binded}.
  *
- * @class core.treeController.Mapper
+ * @memberOf core.treeController
  */
 export default class Mapper {
+	/**
+	 * Creates an instance of the mapper.
+	 */
 	constructor() {
 		/**
 		 * Model element to View element mapping.
 		 *
 		 * @private
-		 * @type {WeakMap}
+		 * @member {WeakMap} core.treeController.Mapper#_modelToViewMapping
 		 */
 		this._modelToViewMapping = new WeakMap();
 
@@ -34,7 +34,7 @@ export default class Mapper {
 		 * View element to Model element mapping.
 		 *
 		 * @private
-		 * @type {WeakMap}
+		 * @member {WeakMap} core.treeController.Mapper#_viewToModelMapping
 		 */
 		this._viewToModelMapping = new WeakMap();
 	}
@@ -44,7 +44,6 @@ export default class Mapper {
 	 * the {@link core.treeController.Mapper#toModelElement toModelElement} and {@link core.treeController.Mapper#toViewElement toViewElement}
 	 * methods. The information that elements are bound is also used to translate positions.
 	 *
-	 * @method core.treeController.Mapper#bindElements
 	 * @param {core.treeModel.Element} modelElement Model element.
 	 * @param {core.treeView.Element} viewElement View element.
 	 */
@@ -56,7 +55,6 @@ export default class Mapper {
 	/**
 	 * Gets the corresponding model element.
 	 *
-	 * @method core.treeController.Mapper#toModelElement
 	 * @param {core.treeView.Element} viewElement View element.
 	 * @returns {core.treeModel.Element|null} Corresponding model element or `null` if not found.
 	 */
@@ -67,7 +65,6 @@ export default class Mapper {
 	/**
 	 * Gets the corresponding view element.
 	 *
-	 * @method core.treeController.Mapper#toViewElement
 	 * @param {core.treeModel.Element} modelElement Model element.
 	 * @returns {core.treeView.Element|null} Corresponding view element or `null` if not found.
 	 */
@@ -98,7 +95,6 @@ export default class Mapper {
 	/**
 	 * Gets the corresponding view position.
 	 *
-	 * @method core.treeController.Mapper#toViewPosition
 	 * @param {core.treeModel.Position} modelPosition Model position.
 	 * @returns {core.treeView.Position} Corresponding view position.
 	 */
@@ -120,7 +116,6 @@ export default class Mapper {
 	 *		<p>foo|<b>bar</b></p> // _toModelOffset( p, 3, p ) -> 3
 	 *		<p>foo<b>ba|r</b></p> // _toModelOffset( b, 2, b ) -> 2
 	 *
-	 * @method core.treeController.Mapper#_toModelOffset
 	 * @private
 	 * @param {core.treeView.Element} viewParent Position parent.
 	 * @param {Number} viewOffset Position offset.
@@ -162,7 +157,6 @@ export default class Mapper {
 	 *		<b>foo</b>   -> 3 // Length the element which has no corresponding model element is a length of its children.
 	 *		<p>foo</p>   -> 1 // Length the element which has corresponding model element is always 1.
 	 *
-	 * @method core.treeController.Mapper#_getModelLength
 	 * @private
 	 * @param {core.treeView.Element} viewNode View node.
 	 * @returns {Number} Length of the node in the tree model.
@@ -206,11 +200,10 @@ export default class Mapper {
 	 *		We are in the text node so we can simple find the offset.
 	 *		<p>fo<b>ba|r</b>bom</p> -> expected offset: 2, actual offset: 2 -> position found
 	 *
-	 * @method core.treeController.Mapper#_findPositionIn
 	 * @private
 	 * @param {core.treeView.Element} viewParent Tree view element in which we are looking for the position.
 	 * @param {Number} expectedOffset Expected offset.
-	 * @returns {core.treeVew.Position} Found position.
+	 * @returns {core.treeView.Position} Found position.
 	 */
 	_findPositionIn( viewParent, expectedOffset ) {
 		// Last scanned view node.

+ 2 - 2
packages/ckeditor5-engine/src/treemodel/delta/attributedelta.js

@@ -12,11 +12,11 @@ import Range from '../range.js';
 import Element from '../element.js';
 
 /**
- * @classdesc To provide specific OT behavior and better collisions solving, change methods ({@link core.treeModel.Batch#setAttr}
+ * To provide specific OT behavior and better collisions solving, change methods ({@link core.treeModel.Batch#setAttr}
  * and {@link core.treeModel.Batch#removeAttr}) use `AttributeDelta` class which inherits from the `Delta` class and may
  * overwrite some methods.
  *
- * @class core.treeModel.delta.AttributeDelta
+ * @memberOf core.treeModel.delta
  * @extends core.treeModel.delta.Delta
  */
 export default class AttributeDelta extends Delta {}

+ 6 - 7
packages/ckeditor5-engine/src/treemodel/delta/delta.js

@@ -6,9 +6,6 @@
 'use strict';
 
 /**
- * Creates a delta instance.
- *
- * @classdesc
  * Base class for all deltas.
  *
  * Delta is a single, from the user action point of view, change in the editable document, like insert, split or
@@ -16,16 +13,19 @@
  *
  * Multiple deltas are grouped into a single {@link core.treeModel.Batch}.
  *
- * @class core.treeModel.delta.Delta
+ * @memberOf core.treeModel.delta
  */
 export default class Delta {
+	/**
+	 * Creates a delta instance.
+	 */
 	constructor() {
 		/**
 		 * {@link core.treeModel.Batch} which delta is a part of. This property is null by default and set by the
 		 * {@link core.treeModel.Batch#addDelta} method.
 		 *
 		 * @readonly
-		 * @type {core.treeModel.Batch}
+		 * @member {core.treeModel.Batch} core.treeModel.delta.Delta#batch
 		 */
 		this.batch = null;
 
@@ -33,7 +33,7 @@ export default class Delta {
 		 * Array of operations which compose delta.
 		 *
 		 * @readonly
-		 * @type {core.treeModel.operation.Operation[]}
+		 * @member {core.treeModel.operation.Operation[]} core.treeModel.delta.Delta#operations
 		 */
 		this.operations = [];
 	}
@@ -41,7 +41,6 @@ export default class Delta {
 	/**
 	 * Add operation to the delta.
 	 *
-	 * @method core.treeModel.delta.Delta#addOperation
 	 * @param {core.treeModel.operation.Operation} operation Operation instance.
 	 */
 	addOperation( operation ) {

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/insertdelta.js

@@ -14,7 +14,7 @@ import InsertOperation from '../operation/insertoperation.js';
  * To provide specific OT behavior and better collisions solving, the {@link core.treeModel.Batch#insert Batch#insert} method
  * uses the `InsertDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.InsertDelta
+ * @memberOf core.treeModel.delta
  */
 export default class InsertDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/mergedelta.js

@@ -18,7 +18,7 @@ import CKEditorError from '../../ckeditorerror.js';
  * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#merge} method
  * uses the `MergeDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.MergeDelta
+ * @memberOf core.treeModel.delta
  */
 export default class MergeDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/movedelta.js

@@ -17,7 +17,7 @@ import CKEditorError from '../../ckeditorerror.js';
  * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#move} method
  * uses the `MoveDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.MoveDelta
+ * @memberOf core.treeModel.delta
  */
 export default class MoveDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/removedelta.js

@@ -16,7 +16,7 @@ import Range from '../range.js';
  * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#remove} method
  * uses the `RemoveDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.RemoveDelta
+ * @memberOf core.treeModel.delta
  */
 export default class RemoveDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/splitdelta.js

@@ -18,7 +18,7 @@ import CKEditorError from '../../ckeditorerror.js';
  * To provide specific OT behavior and better collisions solving, the {@link core.treeModel.Batch#split} method
  * uses `SplitDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.SplitDelta
+ * @memberOf core.treeModel.delta
  */
 export default class SplitDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/unwrapdelta.js

@@ -17,7 +17,7 @@ import CKEditorError from '../../ckeditorerror.js';
  * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#merge} method
  * uses the `UnwrapDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.UnwrapDelta
+ * @memberOf core.treeModel.delta
  */
 export default class UnwrapDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/weakinsertdelta.js

@@ -15,7 +15,7 @@ import NodeList from '../nodelist.js';
  * To provide specific OT behavior and better collisions solving, the {@link core.treeModel.Batch#insert} method
  * uses the `WeakInsertDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.WeakInsertDelta
+ * @memberOf core.treeModel.delta
  */
 export default class WeakInsertDelta extends Delta {}
 

+ 1 - 1
packages/ckeditor5-engine/src/treemodel/delta/wrapdelta.js

@@ -18,7 +18,7 @@ import CKEditorError from '../../ckeditorerror.js';
  * To provide specific OT behavior and better collisions solving, {@link core.treeModel.Batch#merge} method
  * uses the `WrapDelta` class which inherits from the `Delta` class and may overwrite some methods.
  *
- * @class core.treeModel.delta.WrapDelta
+ * @memberOf core.treeModel.delta
  */
 export default class WrapDelta extends Delta {}
 

+ 24 - 28
packages/ckeditor5-engine/src/treemodel/operation/attributeoperation.js

@@ -11,28 +11,30 @@ import CKEditorError from '../../ckeditorerror.js';
 import TextFragment from '../textfragment.js';
 
 /**
- * Creates an operation that changes, removes or adds attributes.
- *
- * If only the new attribute is set, then it will be inserted. Note that in all nodes in ranges there must be
- * no attributes with the same key as the new attribute.
- *
- * If only the old attribute is set, then it will be removed. Note that this attribute must be present in all nodes in
- * ranges.
- *
- * If both new and old attributes are set, then the operation will change the attribute value. Note that both new and
- * old attributes have to have the same key and the old attribute must be present in all nodes in ranges.
- *
- * @param {core.treeModel.Range} range Range on which the operation should be applied.
- * @param {String} key Key of an attribute to change or remove.
- * @param {*} oldValue Old value of the attribute with given key or `null` if adding a new attribute.
- * @param {*} newValue New value to set for the attribute. If `null`, then the operation just removes the attribute.
- * @param {Number} baseVersion {@link core.treeModel.Document#version} on which the operation can be applied.
- * @class core.treeModel.operation.AttributeOperation
- * @classdesc
  * Operation to change nodes' attribute. Using this class you can add, remove or change value of the attribute.
+ *
+ * @memberOf core.treeModel.operation
  * @extends core.treeModel.operation.Operation
  */
 export default class AttributeOperation extends Operation {
+	/**
+	 * Creates an operation that changes, removes or adds attributes.
+	 *
+	 * If only the new attribute is set, then it will be inserted. Note that in all nodes in ranges there must be
+	 * no attributes with the same key as the new attribute.
+	 *
+	 * If only the old attribute is set, then it will be removed. Note that this attribute must be present in all nodes in
+	 * ranges.
+	 *
+	 * If both new and old attributes are set, then the operation will change the attribute value. Note that both new and
+	 * old attributes have to have the same key and the old attribute must be present in all nodes in ranges.
+	 *
+	 * @param {core.treeModel.Range} range Range on which the operation should be applied.
+	 * @param {String} key Key of an attribute to change or remove.
+	 * @param {*} oldValue Old value of the attribute with given key or `null` if adding a new attribute.
+	 * @param {*} newValue New value to set for the attribute. If `null`, then the operation just removes the attribute.
+	 * @param {Number} baseVersion {@link core.treeModel.Document#version} on which the operation can be applied.
+	 */
 	constructor( range, key, oldValue, newValue, baseVersion ) {
 		super( baseVersion );
 
@@ -40,8 +42,7 @@ export default class AttributeOperation extends Operation {
 		 * Range on which operation should be applied.
 		 *
 		 * @readonly
-		 * @member core.treeModel.operation.AttributeOperation#range
-		 * @type {core.treeModel.Range}
+		 * @member {core.treeModel.Range} core.treeModel.operation.AttributeOperation#range
 		 */
 		this.range = Range.createFromRange( range );
 
@@ -49,26 +50,23 @@ export default class AttributeOperation extends Operation {
 		 * Key of an attribute to change or remove.
 		 *
 		 * @readonly
-		 * @member core.treeModel.operation.AttributeOperation#key
-		 * @type {String}
+		 * @member {String} core.treeModel.operation.AttributeOperation#key
 		 */
 		this.key = key;
 
 		/**
 		 * Old value of the attribute with given key or `null` if adding a new attribute.
 		 *
-		 * @member core.treeModel.operation.AttributeOperation#oldValue
 		 * @readonly
-		 * @type {*}
+		 * @member {*} core.treeModel.operation.AttributeOperation#oldValue
 		 */
 		this.oldValue = oldValue;
 
 		/**
 		 * New value to set for the attribute. If `null`, then the operation just removes the attribute.
 		 *
-		 * @member core.treeModel.operation.AttributeOperation#newValue
 		 * @readonly
-		 * @type {*}
+		 * @member {*} core.treeModel.operation.AttributeOperation#newValue
 		 */
 		this.newValue = newValue;
 	}
@@ -78,7 +76,6 @@ export default class AttributeOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.AttributeOperation#clone
 	 * @returns {core.treeModel.operation.AttributeOperation}
 	 */
 	clone() {
@@ -86,7 +83,6 @@ export default class AttributeOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.AttributeOperation#clone
 	 * @returns {core.treeModel.operation.AttributeOperation}
 	 */
 	getReversed() {

+ 12 - 15
packages/ckeditor5-engine/src/treemodel/operation/insertoperation.js

@@ -12,37 +12,36 @@ import Range from '../range.js';
 import RemoveOperation from './removeoperation.js';
 
 /**
- * Creates an insert operation.
- *
- * @param {core.treeModel.Position} position Position of insertion.
- * @param {core.treeModel.NodeSet} nodes The list of nodes to be inserted.
- * List of nodes can be any type accepted by the {@link core.treeModel.NodeList} constructor.
- * @param {Number} baseVersion {@link core.treeModel.Document#version} on which operation can be applied.
- *
- * @class core.treeModel.operation.InsertOperation
- * @classdesc
  * Operation to insert list of nodes on the given position in the tree data model.
+ *
+ * @memberOf core.treeModel.operation
  * @extends core.treeModel.operation.Operation
  */
 export default class InsertOperation extends Operation {
+	/**
+	 * Creates an insert operation.
+	 *
+	 * @param {core.treeModel.Position} position Position of insertion.
+	 * @param {core.treeModel.NodeSet} nodes The list of nodes to be inserted.
+	 * List of nodes can be any type accepted by the {@link core.treeModel.NodeList} constructor.
+	 * @param {Number} baseVersion {@link core.treeModel.Document#version} on which operation can be applied.
+	 */
 	constructor( position, nodes, baseVersion ) {
 		super( baseVersion );
 
 		/**
 		 * Position of insertion.
 		 *
-		 * @member core.treeModel.operation.InsertOperation#position
 		 * @readonly
-		 * @type {core.treeModel.Position}
+		 * @member {core.treeModel.Position} core.treeModel.operation.InsertOperation#position
 		 */
 		this.position = Position.createFromPosition( position );
 
 		/**
 		 * List of nodes to insert.
 		 *
-		 * @member core.treeModel.operation.InsertOperation#nodeList
 		 * @readonly
-		 * @type {core.treeModel.NodeList}
+		 * @member {core.treeModel.NodeList} core.treeModel.operation.InsertOperation#nodeList
 		 */
 		this.nodeList = new NodeList( nodes );
 	}
@@ -52,7 +51,6 @@ export default class InsertOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.InsertOperation#clone
 	 * @returns {core.treeModel.operation.InsertOperation}
 	 */
 	clone() {
@@ -60,7 +58,6 @@ export default class InsertOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.InsertOperation#getReversed
 	 * @returns {core.treeModel.operation.RemoveOperation}
 	 */
 	getReversed() {

+ 13 - 17
packages/ckeditor5-engine/src/treemodel/operation/moveoperation.js

@@ -12,43 +12,41 @@ import CKEditorError from '../../ckeditorerror.js';
 import utils from '../../utils.js';
 
 /**
- * Creates a move operation.
- *
- * @param {core.treeModel.Position} sourcePosition Position before the first node to move.
- * @param {Number} howMany How many consecutive nodes to move, starting from `sourcePosition`.
- * @param {core.treeModel.Position} targetPosition Position where moved nodes will be inserted.
- * @param {Number} baseVersion {@link core.treeModel.Document#version} on which operation can be applied.
- *
- * @class core.treeModel.operation.MoveOperation
- * @classdesc
  * Operation to move list of subsequent nodes from one position in the document to another.
+ *
+ * @memberOf core.treeModel.operation
  * @extends core.treeModel.operation.Operation
  */
 export default class MoveOperation extends Operation {
+	/**
+	 * Creates a move operation.
+	 *
+	 * @param {core.treeModel.Position} sourcePosition Position before the first node to move.
+	 * @param {Number} howMany How many consecutive nodes to move, starting from `sourcePosition`.
+	 * @param {core.treeModel.Position} targetPosition Position where moved nodes will be inserted.
+	 * @param {Number} baseVersion {@link core.treeModel.Document#version} on which operation can be applied.
+	 */
 	constructor( sourcePosition, howMany, targetPosition, baseVersion ) {
 		super( baseVersion );
 
 		/**
 		 * Source move position.
 		 *
-		 * @member core.treeModel.operation.MoveOperation#sourcePosition
-		 * @type {core.treeModel.Position}
+		 * @member {core.treeModel.Position} core.treeModel.operation.MoveOperation#sourcePosition
 		 */
 		this.sourcePosition = Position.createFromPosition( sourcePosition );
 
 		/**
 		 * How many nodes to move.
 		 *
-		 * @member core.treeModel.operation.MoveOperation#howMany
-		 * @type {Number}
+		 * @member {Number} core.treeModel.operation.MoveOperation#howMany
 		 */
 		this.howMany = howMany;
 
 		/**
 		 * Target move position.
 		 *
-		 * @member core.treeModel.operation.MoveOperation#targetPosition
-		 * @type {core.treeModel.Position}
+		 * @member {core.treeModel.Position} core.treeModel.operation.MoveOperation#targetPosition
 		 */
 		this.targetPosition = Position.createFromPosition( targetPosition );
 	}
@@ -58,7 +56,6 @@ export default class MoveOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.MoveOperation#clone
 	 * @returns {core.treeModel.operation.MoveOperation}
 	 */
 	clone() {
@@ -66,7 +63,6 @@ export default class MoveOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.MoveOperation#getReversed
 	 * @returns {core.treeModel.operation.MoveOperation}
 	 */
 	getReversed() {

+ 2 - 4
packages/ckeditor5-engine/src/treemodel/operation/nooperation.js

@@ -8,8 +8,6 @@
 import Operation from './operation.js';
 
 /**
- * @class core.treeModel.operation.NoOperation
- * @classdesc
  * Operation which is doing nothing ("empty operation", "do-nothing operation", "noop").
  * This is an operation, which when executed does not change the tree model.
  * It still has some parameters defined for transformation purposes.
@@ -17,11 +15,12 @@ import Operation from './operation.js';
  * In most cases this operation is a result of transforming operations. When transformation returns
  * {@link core.treeModel.operation.NoOperation} it means that changes done by the transformed operation
  * have already been applied.
+ *
+ * @memberOf core.treeModel.operation
  * @extends core.treeModel.operation.Operation
  */
 export default class NoOperation extends Operation {
 	/**
-	 * @method core.treeModel.operation.NoOperation#clone
 	 * @returns {core.treeModel.operation.NoOperation}
 	 */
 	clone() {
@@ -29,7 +28,6 @@ export default class NoOperation extends Operation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.NoOperation#getReversed
 	 * @returns {core.treeModel.operation.NoOperation}
 	 */
 	getReversed() {

+ 10 - 10
packages/ckeditor5-engine/src/treemodel/operation/operation.js

@@ -6,13 +6,16 @@
 'use strict';
 
 /**
- * Base operation constructor.
- * @param {Number} baseVersion {@link core.treeModel.Document#version} on which the operation can be applied.
+ * Abstract base operation class.
+ *
  * @abstract
- * @class core.treeModel.operation.Operation
- * @classdesc Abstract base operation class.
+ * @memberOf core.treeModel.operation
  */
 export default class Operation {
+	/**
+	 * Base operation constructor.
+	 * @param {Number} baseVersion {@link core.treeModel.Document#version} on which the operation can be applied.
+	 */
 	constructor( baseVersion ) {
 		/**
 		 * {@link core.treeModel.Document#version} on which operation can be applied. If you try to
@@ -20,16 +23,14 @@ export default class Operation {
 		 * {@link core.treeModel.Document#version document version} the {@link document-applyOperation-wrong-version}
 		 * error is thrown.
 		 *
-		 * @type {Number}
-		 * @member core.treeModel.operation.Operation#baseVersion
+		 * @member {Number} core.treeModel.operation.Operation#baseVersion
 		 */
 		this.baseVersion = baseVersion;
 
 		/**
 		 * Operation type.
 		 *
-		 * @type {String}
-		 * @member core.treeModel.operation.Operation#type
+		 * @member {String} core.treeModel.operation.Operation#type
 		 */
 
 		/**
@@ -37,8 +38,7 @@ export default class Operation {
 		 * {@link core.treeModel.Delta delta} when the operations is added to it by the
 		 * {@link core.treeModel.Delta#addOperation} method.
 		 *
-		 * @type {core.treeModel.Delta}
-		 * @member core.treeModel.operation.Operation#delta
+		 * @member {core.treeModel.Delta} core.treeModel.operation.Operation#delta
 		 */
 
 		/**

+ 2 - 3
packages/ckeditor5-engine/src/treemodel/operation/reinsertoperation.js

@@ -9,8 +9,6 @@ import MoveOperation from './moveoperation.js';
 import RemoveOperation from './removeoperation.js';
 
 /**
- * @class core.treeModel.operation.ReinsertOperation
- * @classdesc
  * Operation to reinsert previously removed nodes back to the non-graveyard root.
  * This is basically {@link core.treeModel.operation.MoveOperation} but it returns
  * {@link core.treeModel.operation.RemoveOperation} when reversed.
@@ -18,11 +16,12 @@ import RemoveOperation from './removeoperation.js';
  * With this class, we achieve two goals: by having separate classes it's easier to distinguish whether move
  * operation is actually a remove/reinsert operation and fire proper events. Also it
  * will be easier to expand if we need to change operation's behavior if it is remove/reinsert.
+ *
+ * @memberOf core.treeModel.operation
  * @extends core.treeModel.operation.Operation
  */
 export default class ReinsertOperation extends MoveOperation {
 	/**
-	 * @method core.treeModel.operation.ReinsertOperation#getReversed
 	 * @returns {core.treeModel.operation.RemoveOperation}
 	 */
 	getReversed() {

+ 10 - 9
packages/ckeditor5-engine/src/treemodel/operation/removeoperation.js

@@ -10,17 +10,20 @@ import Position from '../position.js';
 import ReinsertOperation from './reinsertoperation.js';
 
 /**
- * Creates a remove operation.
+ * Operation to remove a range of nodes.
  *
- * @param {core.treeModel.Position} position Position before the first node to remove.
- * @param {Number} howMany How many nodes to remove.
- * @param {Number} baseVersion {@link core.treeModel.Document#version} on which operation can be applied.
- *
- * @class core.treeModel.operation.RemoveOperation
- * @classdesc Operation to remove a range of nodes.
+ * @memberOf core.treeModel.operation
  * @extends core.treeModel.operation.Operation
  */
 export default class RemoveOperation extends MoveOperation {
+	/**
+	 *
+	 * Creates a remove operation.
+	 *
+	 * @param {core.treeModel.Position} position Position before the first node to remove.
+	 * @param {Number} howMany How many nodes to remove.
+	 * @param {Number} baseVersion {@link core.treeModel.Document#version} on which operation can be applied.
+	 */
 	constructor( position, howMany, baseVersion ) {
 		// Position in a graveyard where nodes were moved.
 		const graveyardPosition = Position.createFromParentAndOffset( position.root.document.graveyard, 0 );
@@ -33,7 +36,6 @@ export default class RemoveOperation extends MoveOperation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.ReinsertOperation#getReversed
 	 * @returns {core.treeModel.operation.ReinsertOperation}
 	 */
 	getReversed() {
@@ -41,7 +43,6 @@ export default class RemoveOperation extends MoveOperation {
 	}
 
 	/**
-	 * @method core.treeModel.operation.RemoveOperation#clone
 	 * @returns {core.treeModel.operation.RemoveOperation}
 	 */
 	clone() {