Browse Source

Started fixing docs in engine.

Maciek 9 years ago
parent
commit
6af1af021f
71 changed files with 331 additions and 205 deletions
  1. 58 55
      packages/ckeditor5-engine/src/controller/datacontroller.js
  2. 4 0
      packages/ckeditor5-engine/src/controller/deletecontent.js
  3. 12 10
      packages/ckeditor5-engine/src/controller/editingcontroller.js
  4. 29 27
      packages/ckeditor5-engine/src/controller/insertcontent.js
  5. 4 0
      packages/ckeditor5-engine/src/controller/modifyselection.js
  6. 4 0
      packages/ckeditor5-engine/src/conversion/buildmodelconverter.js
  7. 4 0
      packages/ckeditor5-engine/src/conversion/buildviewconverter.js
  8. 0 8
      packages/ckeditor5-engine/src/conversion/conversion.jsdoc
  9. 4 0
      packages/ckeditor5-engine/src/conversion/mapper.js
  10. 4 0
      packages/ckeditor5-engine/src/conversion/model-selection-to-view-converters.js
  11. 4 0
      packages/ckeditor5-engine/src/conversion/model-to-view-converters.js
  12. 4 0
      packages/ckeditor5-engine/src/conversion/modelconsumable.js
  13. 4 0
      packages/ckeditor5-engine/src/conversion/modelconversiondispatcher.js
  14. 4 0
      packages/ckeditor5-engine/src/conversion/view-selection-to-model-converters.js
  15. 4 0
      packages/ckeditor5-engine/src/conversion/view-to-model-converters.js
  16. 4 0
      packages/ckeditor5-engine/src/conversion/viewconsumable.js
  17. 4 0
      packages/ckeditor5-engine/src/conversion/viewconversiondispatcher.js
  18. 4 0
      packages/ckeditor5-engine/src/dataprocessor/basichtmlwriter.js
  19. 0 32
      packages/ckeditor5-engine/src/dataprocessor/dataprocessor.jsdoc
  20. 4 0
      packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js
  21. 4 0
      packages/ckeditor5-engine/src/dataprocessor/htmlwriter.js
  22. 4 0
      packages/ckeditor5-engine/src/dataprocessor/xmldataprocessor.js
  23. 0 12
      packages/ckeditor5-engine/src/dev-utils/dev-utils.jsdoc
  24. 4 0
      packages/ckeditor5-engine/src/dev-utils/model.js
  25. 4 0
      packages/ckeditor5-engine/src/dev-utils/view.js
  26. 0 8
      packages/ckeditor5-engine/src/engine.jsdoc
  27. 4 0
      packages/ckeditor5-engine/src/model/batch.js
  28. 0 8
      packages/ckeditor5-engine/src/model/delta/delta.jsdoc
  29. 4 0
      packages/ckeditor5-engine/src/model/document.js
  30. 4 0
      packages/ckeditor5-engine/src/model/documentfragment.js
  31. 4 0
      packages/ckeditor5-engine/src/model/element.js
  32. 4 0
      packages/ckeditor5-engine/src/model/history.js
  33. 0 10
      packages/ckeditor5-engine/src/model/item.jsdoc
  34. 4 0
      packages/ckeditor5-engine/src/model/liveposition.js
  35. 4 0
      packages/ckeditor5-engine/src/model/liverange.js
  36. 4 0
      packages/ckeditor5-engine/src/model/liveselection.js
  37. 0 8
      packages/ckeditor5-engine/src/model/model.jsdoc
  38. 4 0
      packages/ckeditor5-engine/src/model/node.js
  39. 4 0
      packages/ckeditor5-engine/src/model/nodelist.js
  40. 0 9
      packages/ckeditor5-engine/src/model/operation/operation.jsdoc
  41. 4 0
      packages/ckeditor5-engine/src/model/position.js
  42. 4 0
      packages/ckeditor5-engine/src/model/range.js
  43. 4 0
      packages/ckeditor5-engine/src/model/rootelement.js
  44. 4 0
      packages/ckeditor5-engine/src/model/schema.js
  45. 4 0
      packages/ckeditor5-engine/src/model/selection.js
  46. 4 0
      packages/ckeditor5-engine/src/model/text.js
  47. 4 0
      packages/ckeditor5-engine/src/model/textproxy.js
  48. 4 0
      packages/ckeditor5-engine/src/model/treewalker.js
  49. 4 0
      packages/ckeditor5-engine/src/model/writer.js
  50. 4 0
      packages/ckeditor5-engine/src/view/attributeelement.js
  51. 4 0
      packages/ckeditor5-engine/src/view/containerelement.js
  52. 4 0
      packages/ckeditor5-engine/src/view/document.js
  53. 4 0
      packages/ckeditor5-engine/src/view/documentfragment.js
  54. 4 0
      packages/ckeditor5-engine/src/view/domconverter.js
  55. 4 0
      packages/ckeditor5-engine/src/view/editableelement.js
  56. 4 0
      packages/ckeditor5-engine/src/view/element.js
  57. 4 0
      packages/ckeditor5-engine/src/view/emptyelement.js
  58. 4 0
      packages/ckeditor5-engine/src/view/filler.js
  59. 0 10
      packages/ckeditor5-engine/src/view/item.jsdoc
  60. 4 0
      packages/ckeditor5-engine/src/view/matcher.js
  61. 4 0
      packages/ckeditor5-engine/src/view/node.js
  62. 4 0
      packages/ckeditor5-engine/src/view/position.js
  63. 4 0
      packages/ckeditor5-engine/src/view/range.js
  64. 4 0
      packages/ckeditor5-engine/src/view/renderer.js
  65. 4 0
      packages/ckeditor5-engine/src/view/rooteditableelement.js
  66. 4 0
      packages/ckeditor5-engine/src/view/selection.js
  67. 4 0
      packages/ckeditor5-engine/src/view/text.js
  68. 4 0
      packages/ckeditor5-engine/src/view/textproxy.js
  69. 4 0
      packages/ckeditor5-engine/src/view/treewalker.js
  70. 0 8
      packages/ckeditor5-engine/src/view/view.jsdoc
  71. 4 0
      packages/ckeditor5-engine/src/view/writer.js

+ 58 - 55
packages/ckeditor5-engine/src/controller/datacontroller.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/controller/datacontroller
+ */
+
 import mix from '../../utils/mix.js';
 import EmitterMixin from '../../utils/emittermixin.js';
 
@@ -25,30 +29,29 @@ import modifySelection from './modifyselection.js';
 
 /**
  * Controller for the data pipeline. The data pipeline controls how data is retrieved from the document
- * and set inside it. Hence, the controller features two methods which allow to {@link engine.controller.DataController#get get}
- * and {@link engine.controller.DataController#set set} data of the {@link engine.controller.DataController#model model}
+ * and set inside it. Hence, the controller features two methods which allow to {@link #get get}
+ * and {@link #set set} data of the {@link #model model}
  * using given:
  *
- * * {@link engine.dataProcessor.DataProcessor data processor},
- * * {@link engine.conversion.ModelConversionDispatcher model to view} and
- * * {@link engine.conversion.ViewConversionDispatcher view to model} converters.
+ * * {@link module:engine/dataProcessor.DataProcessor data processor},
+ * * {@link module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher model to view} and
+ * * {@link module:engine/conversion/viewconversiondispatcher~ViewConversionDispatcher view to model} converters.
  *
- * @memberOf engine.controller
- * @mixes utils.EmitterMixin
+ * @mixes module:utils/emittermixin~EmitterMixin
  */
 export default class DataController {
 	/**
 	 * Creates data controller instance.
 	 *
-	 * @param {engine.model.Document} model Document model.
-	 * @param {engine.dataProcessor.DataProcessor} [dataProcessor] Data processor which should used by the controller.
+	 * @param {module:engine/model/document~Document} model Document model.
+	 * @param {module:engine/dataProcessor~DataProcessor} [dataProcessor] Data processor which should used by the controller.
 	 */
 	constructor( model, dataProcessor ) {
 		/**
 		 * Document model.
 		 *
 		 * @readonly
-		 * @member {engine.model.document} engine.controller.DataController#model
+		 * @member {module:engine/model/document}
 		 */
 		this.model = model;
 
@@ -56,7 +59,7 @@ export default class DataController {
 		 * Data processor used during the conversion.
 		 *
 		 * @readonly
-		 * @member {engine.dataProcessor.DataProcessor} engine.controller.DataController#processor
+		 * @member {engine.dataProcessor.DataProcessor}
 		 */
 		this.processor = dataProcessor;
 
@@ -65,12 +68,12 @@ export default class DataController {
 		 * cleared directly after data are converted. However, the mapper is defined as class property, because
 		 * it needs to be passed to the `ModelConversionDispatcher` as a conversion API.
 		 *
-		 * @member {engine.conversion.Mapper} engine.controller.DataController#_mapper
+		 * @member {engine.conversion.Mapper}
 		 */
 		this.mapper = new Mapper();
 
 		/**
-		 * Model to view conversion dispatcher used by the {@link engine.controller.DataController#get get method}.
+		 * Model to view conversion dispatcher used by the {@link #get get method}.
 		 * To attach model to view converter to the data pipeline you need to add lister to this property:
 		 *
 		 *		data.modelToView( 'insert:$element', customInsertConverter );
@@ -80,7 +83,7 @@ export default class DataController {
 		 *		buildModelConverter().for( data.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
 		 *
 		 * @readonly
-		 * @member {engine.conversion.ModelConversionDispatcher} engine.controller.DataController#modelToView
+		 * @member {engine.conversion.ModelConversionDispatcher}
 		 */
 		this.modelToView = new ModelConversionDispatcher( {
 			mapper: this.mapper
@@ -88,7 +91,7 @@ export default class DataController {
 		this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } );
 
 		/**
-		 * View to model conversion dispatcher used by the {@link engine.controller.DataController#set set method}.
+		 * View to model conversion dispatcher used by the {@link #set set method}.
 		 * To attach view to model converter to the data pipeline you need to add lister to this property:
 		 *
 		 *		data.viewToModel( 'element', customElementConverter );
@@ -98,7 +101,7 @@ export default class DataController {
 		 *		buildViewConverter().for( data.viewToModel ).fromElement( 'b' ).toAttribute( 'bold', 'true' );
 		 *
 		 * @readonly
-		 * @member {engine.conversion.ViewConversionDispatcher} engine.controller.DataController#viewToModel
+		 * @member {engine.conversion.ViewConversionDispatcher}
 		 */
 		this.viewToModel = new ViewConversionDispatcher( {
 			schema: model.schema
@@ -119,8 +122,8 @@ export default class DataController {
 	}
 
 	/**
-	 * Returns model's data converted by the {@link engine.controller.DataController#modelToView model to view converters} and
-	 * formatted by the {@link engine.controller.DataController#processor data processor}.
+	 * Returns model's data converted by the {@link #modelToView model to view converters} and
+	 * formatted by the {@link #processor data processor}.
 	 *
 	 * @param {String} [rootName='main'] Root name.
 	 * @returns {String} Output data.
@@ -131,11 +134,11 @@ export default class DataController {
 	}
 
 	/**
-	 * Returns the content of the given {@link engine.model.Element model's element} converted by the
-	 * {@link engine.controller.DataController#modelToView model to view converters} and formatted by the
-	 * {@link engine.controller.DataController#processor data processor}.
+	 * Returns the content of the given {@link module:engine/model/Element model's element} converted by the
+	 * {@link #modelToView model to view converters} and formatted by the
+	 * {@link #processor data processor}.
 	 *
-	 * @param {engine.model.Element} modelElement Element which content will be stringified.
+	 * @param {module:engine/model/Element} modelElement Element which content will be stringified.
 	 * @returns {String} Output data.
 	 */
 	stringify( modelElement ) {
@@ -147,11 +150,11 @@ export default class DataController {
 	}
 
 	/**
-	 * Returns the content of the given {@link engine.model.Element model's element} converted by the
-	 * {@link engine.controller.DataController#modelToView model to view converters} to the
+	 * Returns the content of the given {@link module:engine/model/Element model's element} converted by the
+	 * {@link #modelToView model to view converters} to the
 	 * {@link engine.view.DocumentFragment view DocumentFragment}.
 	 *
-	 * @param {engine.model.Element} modelElement Element which content will be stringified.
+	 * @param {module:engine/model/Element} modelElement Element which content will be stringified.
 	 * @returns {engine.view.DocumentFragment} Output view DocumentFragment.
 	 */
 	toView( modelElement ) {
@@ -168,11 +171,11 @@ export default class DataController {
 	}
 
 	/**
-	 * Sets input data parsed by the {@link engine.controller.DataController#processor data processor} and
-	 * converted by the {@link engine.controller.DataController#viewToModel view to model converters}.
+	 * Sets input data parsed by the {@link #processor data processor} and
+	 * converted by the {@link #viewToModel view to model converters}.
 	 *
 	 * This method also creates a batch with all the changes applied. If all you need is to parse data use
-	 * the {@link engine.controller.DataController#parse} method.
+	 * the {@link #parse} method.
 	 *
 	 * @param {String} data Input data.
 	 * @param {String} [rootName='main'] Root name.
@@ -195,14 +198,14 @@ export default class DataController {
 	}
 
 	/**
-	 * Returns data parsed by the {@link engine.controller.DataController#processor data processor} and then
-	 * converted by the {@link engine.controller.DataController#viewToModel view to model converters}.
+	 * Returns data parsed by the {@link #processor data processor} and then
+	 * converted by the {@link #viewToModel view to model converters}.
 	 *
-	 * @see engine.controller.DataController#set
+	 * @see #set
 	 * @param {String} data Data to parse.
 	 * @param {String} [context='$root'] Base context in which view will be converted to the model. See:
 	 * {@link engine.conversion.ViewConversionDispatcher#convert}.
-	 * @returns {engine.model.DocumentFragment} Parsed data.
+	 * @returns {module:engine/model/DocumentFragment} Parsed data.
 	 */
 	parse( data, context = '$root' ) {
 		// data -> view
@@ -220,10 +223,10 @@ export default class DataController {
 	/**
 	 * See {@link engine.controller.insertContent}.
 	 *
-	 * @fires engine.controller.DataController#insertContent
-	 * @param {engine.model.DocumentFragment} content The content to insert.
-	 * @param {engine.model.Selection} selection Selection into which the content should be inserted.
-	 * @param {engine.model.Batch} [batch] Batch to which deltas will be added. If not specified, then
+	 * @fires insertContent
+	 * @param {module:engine/model/DocumentFragment} content The content to insert.
+	 * @param {module:engine/model/Selection} selection Selection into which the content should be inserted.
+	 * @param {module:engine/model/Batch} [batch] Batch to which deltas will be added. If not specified, then
 	 * changes will be added to a new batch.
 	 */
 	insertContent( content, selection, batch ) {
@@ -241,9 +244,9 @@ export default class DataController {
 	 * the selection inside the last selected cell" or "delete the row and collapse selection somewhere near".
 	 * That needs to be done in order to ensure that other features which use `deleteContent()` will work well with tables.
 	 *
-	 * @fires engine.controller.DataController#deleteContent
-	 * @param {engine.model.Selection} selection Selection of which the content should be deleted.
-	 * @param {engine.model.Batch} batch Batch to which deltas will be added.
+	 * @fires deleteContent
+	 * @param {module:engine/model/Selection} selection Selection of which the content should be deleted.
+	 * @param {module:engine/model/Batch} batch Batch to which deltas will be added.
 	 * @param {Object} options See {@link engine.controller.deleteContent}'s options.
 	 */
 	deleteContent( selection, batch, options ) {
@@ -253,8 +256,8 @@ export default class DataController {
 	/**
 	 * See {@link engine.controller.modifySelection}.
 	 *
-	 * @fires engine.controller.DataController#modifySelection
-	 * @param {engine.model.Selection} The selection to modify.
+	 * @fires modifySelection
+	 * @param {module:engine/model/Selection} The selection to modify.
 	 * @param {Object} options See {@link engine.controller.modifySelection}'s options.
 	 */
 	modifySelection( selection, options ) {
@@ -265,36 +268,36 @@ export default class DataController {
 mix( DataController, EmitterMixin );
 
 /**
- * Event fired when {@link engine.controller.DataController#insertContent} method is called.
- * The {@link engine.controller.dataController.insertContent default action of that method} is implemented as a
+ * Event fired when {@link #insertContent} method is called.
+ * The {@link .insertContent default action of that method} is implemented as a
  * listener to this event so it can be fully customized by the features.
  *
- * @event engine.controller.DataController#insertContent
+ * @event insertContent
  * @param {Object} data
  * @param {engine.view.DocumentFragment} data.content The content to insert.
- * @param {engine.model.Selection} data.selection Selection into which the content should be inserted.
- * @param {engine.model.Batch} [data.batch] Batch to which deltas will be added.
+ * @param {module:engine/model/Selection} data.selection Selection into which the content should be inserted.
+ * @param {module:engine/model/Batch} [data.batch] Batch to which deltas will be added.
  */
 
 /**
- * Event fired when {@link engine.controller.DataController#deleteContent} method is called.
+ * Event fired when {@link #deleteContent} method is called.
  * The {@link engine.controller.deleteContent default action of that method} is implemented as a
  * listener to this event so it can be fully customized by the features.
  *
- * @event engine.controller.DataController#deleteContent
+ * @event deleteContent
  * @param {Object} data
- * @param {engine.model.Batch} data.batch
- * @param {engine.model.Selection} data.selection
+ * @param {module:engine/model/Batch} data.batch
+ * @param {module:engine/model/Selection} data.selection
  * @param {Object} data.options See {@link engine.controller.deleteContent}'s options.
  */
 
 /**
- * Event fired when {@link engine.controller.DataController#modifySelection} method is called.
- * The {@link engine.controller.modifySelection default action of that method} is implemented as a
+ * Event fired when {@link #modifySelection} method is called.
+ * The {@link module:engine/controller/modifyselection~modifySelection default action of that method} is implemented as a
  * listener to this event so it can be fully customized by the features.
  *
- * @event engine.controller.DataController#modifySelection
+ * @event modifySelection
  * @param {Object} data
- * @param {engine.model.Selection} data.selection
- * @param {Object} data.options See {@link engine.controller.modifySelection}'s options.
+ * @param {module:engine/model/Selection} data.selection
+ * @param {Object} data.options See {@link module:engine/controller/modifyselection~modifySelection}'s options.
  */

+ 4 - 0
packages/ckeditor5-engine/src/controller/deletecontent.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/controller/deletecontent
+ */
+
 import LivePosition from '../model/liveposition.js';
 import Position from '../model/position.js';
 import Element from '../model/element.js';

+ 12 - 10
packages/ckeditor5-engine/src/controller/editingcontroller.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/controller/editingcontroller
+ */
+
 import ViewDocument from '../view/document.js';
 import Mapper from '../conversion/mapper.js';
 import ModelConversionDispatcher from '../conversion/modelconversiondispatcher.js';
@@ -21,21 +25,19 @@ import EmitterMixin from '../../utils/emittermixin.js';
  * Controller for the editing pipeline. The editing pipeline controls {@link engine.controller.EditingController#model model} rendering,
  * including selection handling. It also creates {@link engine.controller.EditingController#view view document} which build a
  * browser-independent virtualization over the DOM elements. Editing controller also attach default converters.
- *
- * @memberOf engine.controller
  */
 export default class EditingController {
 	/**
 	 * Creates editing controller instance.
 	 *
-	 * @param {engine.model.Document} model Document model.
+	 * @param {module:engine/model/document~Document} model Document model.
 	 */
 	constructor( model ) {
 		/**
 		 * Document model.
 		 *
 		 * @readonly
-		 * @member {engine.model.document} engine.controller.EditingController#model
+		 * @member {engine.model.document}
 		 */
 		this.model = model;
 
@@ -43,7 +45,7 @@ export default class EditingController {
 		 * View document.
 		 *
 		 * @readonly
-		 * @member {engine.view.document} engine.controller.EditingController#view
+		 * @member {engine.view.document}
 		 */
 		this.view = new ViewDocument();
 
@@ -51,13 +53,13 @@ export default class EditingController {
 		 * Mapper which describes model-view binding.
 		 *
 		 * @readonly
-		 * @member {engine.conversion.Mapper} engine.controller.EditingController#mapper
+		 * @member {engine.conversion.Mapper}
 		 */
 		this.mapper = new Mapper();
 
 		/**
 		 * Model to view conversion dispatcher, which converts changes from the model to
-		 * {@link engine.controller.EditingController#view editing view}.
+		 * {@link #view editing view}.
 		 *
 		 * To attach model to view converter to the editing pipeline you need to add lister to this property:
 		 *
@@ -68,7 +70,7 @@ export default class EditingController {
 		 *		buildModelConverter().for( editing.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
 		 *
 		 * @readonly
-		 * @member {engine.conversion.ModelConversionDispatcher} engine.controller.EditingController#modelToView
+		 * @member {engine.conversion.ModelConversionDispatcher} #modelToView
 		 */
 		this.modelToView = new ModelConversionDispatcher( {
 			mapper: this.mapper,
@@ -77,10 +79,10 @@ export default class EditingController {
 
 		/**
 		 * Property keeping all listenters attached by controller on other objects, so it can
-		 * stop listening on {@link engine.controller.EditingController#destroy}.
+		 * stop listening on {@link #destroy}.
 		 *
 		 * @private
-		 * @member {utils.EmitterMixin} engine.controller.EditingController#_listenter
+		 * @member {utils.EmitterMixin} #_listenter
 		 */
 		this._listenter = Object.create( EmitterMixin );
 

+ 29 - 27
packages/ckeditor5-engine/src/controller/insertcontent.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/controller/insertcontent
+ */
+
 import Position from '../model/position.js';
 import LivePosition from '../model/liveposition.js';
 import Text from '../model/text.js';
@@ -14,16 +18,15 @@ import log from '../../utils/log.js';
  * Inserts content into the editor (specified selection) as one would expect the paste
  * functionality to work.
  *
- * **Note:** Use {@link engine.controller.DataController#insertContent} instead of this function.
+ * **Note:** Use {@link module:engine/controller/datacontroller~DataController#insertContent} instead of this function.
  * This function is only exposed to be reusable in algorithms which change the {@link engine.controller.DataController#insertContent}
  * method's behavior.
  *
- * @method engine.controller.insertContent
- * @param {engine.controller.DataController} dataController The data controller in context of which the insertion
+ * @param {module:engine/controller/datacontroller~DataController} dataController The data controller in context of which the insertion
  * should be performed.
- * @param {engine.model.DocumentFragment} content The content to insert.
- * @param {engine.model.Selection} selection Selection into which the content should be inserted.
- * @param {engine.model.Batch} [batch] Batch to which deltas will be added. If not specified, then
+ * @param {module:engine/model/documentfragment~DocumentFragment} content The content to insert.
+ * @param {module:engine/model/selection~Selection} selection Selection into which the content should be inserted.
+ * @param {module:engine/model/batch~Batch} [batch] Batch to which deltas will be added. If not specified, then
  * changes will be added to a new batch.
  */
 export default function insertContent( dataController, content, selection, batch ) {
@@ -53,28 +56,27 @@ export default function insertContent( dataController, content, selection, batch
  * Utility class for performing content insertion.
  *
  * @private
- * @memberOf engine.dataController.insert
  */
 class Insertion {
 	constructor( dataController, batch, position ) {
 		/**
 		 * The data controller in context of which the insertion should be performed.
 		 *
-		 * @member {engine.controller.DataController} #dataController
+		 * @member {module:engine/controller/datacontroller~DataController} #dataController
 		 */
 		this.dataController = dataController;
 
 		/**
 		 * Batch to which deltas will be added.
 		 *
-		 * @member {engine.model.Batch} #batch
+		 * @member {module:engine/controller/batch~Batch} #batch
 		 */
 		this.batch = batch;
 
 		/**
 		 * The position at which (or near which) the next node will be inserted.
 		 *
-		 * @member {engine.model.Position} #position
+		 * @member {module:engine/model/position~Position} #position
 		 */
 		this.position = position;
 
@@ -94,7 +96,7 @@ class Insertion {
 		/**
 		 * Schema of the model.
 		 *
-		 * @member {engine.model.Schema} #schema
+		 * @member {module:engine/model/schema~Schema} #schema
 		 */
 		this.schema = dataController.model.schema;
 	}
@@ -102,7 +104,7 @@ class Insertion {
 	/**
 	 * Handles insertion of a set of nodes.
 	 *
-	 * @param {Iterable.<engine.model.Node>} nodes Nodes to insert.
+	 * @param {Iterable.<module:engine/model/node~Node>} nodes Nodes to insert.
 	 * @param {Object} parentContext Context in which parent of these nodes was supposed to be inserted.
 	 * If the parent context is passed it means that the parent element was stripped (was not allowed).
 	 */
@@ -122,7 +124,7 @@ class Insertion {
 	/**
 	 * Returns a range to be selected after insertion.
 	 *
-	 * @returns {engine.model.Range}
+	 * @returns {module:engine/model/range~Range}
 	 */
 	getSelectionRanges() {
 		if ( this.nodeToSelect ) {
@@ -138,7 +140,7 @@ class Insertion {
 	/**
 	 * Handles insertion of a single node.
 	 *
-	 * @param {engine.model.Node} node
+	 * @param {module:engine/model/node~Node} node
 	 * @param {Object} context
 	 * @param {Boolean} context.isFirst Whether the given node is the first one in the content to be inserted.
 	 * @param {Boolean} context.isLast Whether the given node is the last one in the content to be inserted.
@@ -182,7 +184,7 @@ class Insertion {
 	}
 
 	/**
-	 * @param {engine.model.Element} node The object element.
+	 * @param {module:engine/model/element~Element} node The object element.
 	 * @param {Object} context
 	 */
 	_handleObject( node, context ) {
@@ -197,7 +199,7 @@ class Insertion {
 	}
 
 	/**
-	 * @param {engine.model.Node} node The disallowed node which needs to be handled.
+	 * @param {module:engine/model/node~Node} node The disallowed node which needs to be handled.
 	 * @param {Object} context
 	 */
 	_handleDisallowedNode( node, context ) {
@@ -212,7 +214,7 @@ class Insertion {
 	}
 
 	/**
-	 * @param {engine.model.Node} node The node to insert.
+	 * @param {module:engine/model/node~Node} node The node to insert.
 	 */
 	_insert( node ) {
 		/* istanbul ignore if */
@@ -243,7 +245,7 @@ class Insertion {
 	}
 
 	/**
-	 * @param {engine.model.Node} node The node which could potentially be merged.
+	 * @param {module:engine/model/node~Node} node The node which could potentially be merged.
 	 * @param {Object} context
 	 */
 	_mergeSiblingsOf( node, context ) {
@@ -297,7 +299,7 @@ class Insertion {
 	/**
 	 * Tries wrapping the node in a new paragraph and inserting it this way.
 	 *
-	 * @param {engine.model.Node} node The node which needs to be autoparagraphed.
+	 * @param {module:engine/model/node~Node} node The node which needs to be autoparagraphed.
 	 * @param {Object} context
 	 */
 	_tryAutoparagraphing( node, context ) {
@@ -314,7 +316,7 @@ class Insertion {
 	}
 
 	/**
-	 * @param {engine.model.Node} node
+	 * @param {module:engine/model/node~Node} node
 	 */
 	_checkAndSplitToAllowedPosition( node ) {
 		const allowedIn = this._getAllowedIn( node, this.position.parent );
@@ -352,9 +354,9 @@ class Insertion {
 	/**
 	 * Gets the element in which the given node is allowed. It checks the passed element and all its ancestors.
 	 *
-	 * @param {engine.model.Node} node The node to check.
-	 * @param {engine.model.Element} element The element in which the node's correctness should be checked.
-	 * @returns {engine.model.Element|null}
+	 * @param {module:engine/model/node~Node} node The node to check.
+	 * @param {module:engine/model/element~Element} element The element in which the node's correctness should be checked.
+	 * @returns {module:engine/model/element~Element|null}
 	 */
 	_getAllowedIn( node, element ) {
 		if ( this._checkIsAllowed( node, [ element ] ) ) {
@@ -371,8 +373,8 @@ class Insertion {
 	/**
 	 * Check whether the given node is allowed in the specified schema path.
 	 *
-	 * @param {engine.model.Node} node
-	 * @param {engine.model.SchemaPath} path
+	 * @param {module:engine/model/node~Node} node
+	 * @param {module:engine/model/schemapath~SchemaPath} path
 	 */
 	_checkIsAllowed( node, path ) {
 		return this.schema.check( {
@@ -385,7 +387,7 @@ class Insertion {
 	/**
 	 * Checks wether according to the schema this is an object type element.
 	 *
-	 * @param {engine.model.Node} node The node to check.
+	 * @param {module:engine/model/node~Node} node The node to check.
 	 */
 	_checkIsObject( node ) {
 		return this.schema.objects.has( this._getNodeSchemaName( node ) );
@@ -394,7 +396,7 @@ class Insertion {
 	/**
 	 * Gets a name under which we should check this node in the schema.
 	 *
-	 * @param {engine.model.Node} node The node.
+	 * @param {module:engine/model/node~Node} node The node.
 	 */
 	_getNodeSchemaName( node ) {
 		if ( node instanceof Text ) {

+ 4 - 0
packages/ckeditor5-engine/src/controller/modifyselection.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/controller/modifyselection
+ */
+
 import Position from '../model/position.js';
 import TreeWalker from '../model/treewalker.js';
 import Range from '../model/range.js';

+ 4 - 0
packages/ckeditor5-engine/src/conversion/buildmodelconverter.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/buildmodelconverter
+ */
+
 import {
 	insertElement,
 	setAttribute,

+ 4 - 0
packages/ckeditor5-engine/src/conversion/buildviewconverter.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/buildviewconverter
+ */
+
 import Matcher from '../view/matcher.js';
 import ModelElement from '../model/element.js';
 import ModelPosition from '../model/position.js';

+ 0 - 8
packages/ckeditor5-engine/src/conversion/conversion.jsdoc

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine.conversion
- */

+ 4 - 0
packages/ckeditor5-engine/src/conversion/mapper.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/mapper
+ */
+
 import ModelPosition from '../model/position.js';
 import ModelRange from '../model/range.js';
 

+ 4 - 0
packages/ckeditor5-engine/src/conversion/model-selection-to-view-converters.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/model-selection-to-view-converters
+ */
+
 import ViewElement from '../view/element.js';
 import ViewRange from '../view/range.js';
 import viewWriter from '../view/writer.js';

+ 4 - 0
packages/ckeditor5-engine/src/conversion/model-to-view-converters.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/model-to-view-converters
+ */
+
 import ModelRange from '../model/range.js';
 import ModelPosition from '../model/position.js';
 import ModelElement from '../model/element.js';

+ 4 - 0
packages/ckeditor5-engine/src/conversion/modelconsumable.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/modelconsumable
+ */
+
 import TextProxy from '../model/textproxy.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/conversion/modelconversiondispatcher.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/modelconversiondispatcher
+ */
+
 import Consumable from './modelconsumable.js';
 import Range from '../model/range.js';
 import TextProxy from '../model/textproxy.js';

+ 4 - 0
packages/ckeditor5-engine/src/conversion/view-selection-to-model-converters.js

@@ -4,6 +4,10 @@
  */
 
 /**
+ * @module engine/conversion/view-selection-to-model-converters
+ */
+
+/**
  * Contains {@link engine.view.Selection view selection} to {@link engine.model.Selection model selection} conversion
  * helper.
  *

+ 4 - 0
packages/ckeditor5-engine/src/conversion/view-to-model-converters.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/view-to-model-converters
+ */
+
 import ModelDocumentFragment from '../model/documentfragment.js';
 import ModelText from '../model/text.js';
 import { normalizeNodes } from '../model/writer.js';

+ 4 - 0
packages/ckeditor5-engine/src/conversion/viewconsumable.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/viewconsumable
+ */
+
 import isArray from '../../utils/lib/lodash/isArray.js';
 import CKEditorError from '../../utils/ckeditorerror.js';
 import ViewElement from '../view/element.js';

+ 4 - 0
packages/ckeditor5-engine/src/conversion/viewconversiondispatcher.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/conversion/viewconversiondispatcher
+ */
+
 import ViewConsumable from './viewconsumable.js';
 import ViewElement from '../view/element.js';
 import ViewText from '../view/text.js';

+ 4 - 0
packages/ckeditor5-engine/src/dataprocessor/basichtmlwriter.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/dataprocessor/basichtmlwriter
+ */
+
 /* globals document */
 
 /**

+ 0 - 32
packages/ckeditor5-engine/src/dataprocessor/dataprocessor.jsdoc

@@ -1,32 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine.dataProcessor
- */
-
-/**
- * DataProcessor interface. It should be implemented by actual DataProcessors.
- * Each data processor implements a certain format of the data. E.g. `MarkdownDataProcessor` will convert the data
- * (Markdown string) to a {@link engine.view.DocumentFragment DocumentFragment} and back.
- *
- * @interface engine.dataProcessor.DataProcessor
- */
-
-/**
- * Converts a {@link engine.view.DocumentFragment DocumentFragment} to data.
- *
- * @method engine.dataProcessor.DataProcessor#toData
- * @param {engine.view.DocumentFragment} fragment DocumentFragment to be processed.
- * @returns {*}
- */
-
-/**
- * Converts data to a {@link engine.view.DocumentFragment DocumentFragment}.
- *
- * @method engine.dataProcessor.DataProcessor#toView
- * @param {*} data Data to be processed.
- * @returns {engine.view.DocumentFragment}
- */

+ 4 - 0
packages/ckeditor5-engine/src/dataprocessor/htmldataprocessor.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/dataprocessor/htmldataprocessor
+ */
+
 /* globals document, DOMParser */
 
 import BasicHtmlWriter from './basichtmlwriter.js';

+ 4 - 0
packages/ckeditor5-engine/src/dataprocessor/htmlwriter.js

@@ -4,6 +4,10 @@
  */
 
 /**
+ * @module engine/dataprocessor/htmlwriter
+ */
+
+/**
  * HTML writer interface.
  *
  * @interface engine.dataProcessor.HtmlWriter

+ 4 - 0
packages/ckeditor5-engine/src/dataprocessor/xmldataprocessor.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/dataprocessor/xmldataprocessor
+ */
+
 /* globals DOMParser, document */
 
 import BasicHtmlWriter from './basichtmlwriter.js';

+ 0 - 12
packages/ckeditor5-engine/src/dev-utils/dev-utils.jsdoc

@@ -1,12 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine.dev-utils
- */
-
-/**
- * Collection of utilities for manipulating {@link engine.view engine.view} and {@link engine.model engine.model} in testing environment.
- */

+ 4 - 0
packages/ckeditor5-engine/src/dev-utils/model.js

@@ -4,6 +4,10 @@
  */
 
 /**
+ * @module engine/dev-utils/model
+ */
+
+/**
  * @namespace engine.dev-utils.model
  */
 

+ 4 - 0
packages/ckeditor5-engine/src/dev-utils/view.js

@@ -4,6 +4,10 @@
  */
 
 /**
+ * @module engine/dev-utils/view
+ */
+
+/**
  * @namespace engine.dev-utils.view
  */
 

+ 0 - 8
packages/ckeditor5-engine/src/engine.jsdoc

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine
- */

+ 4 - 0
packages/ckeditor5-engine/src/model/batch.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/batch
+ */
+
 import CKEditorError from '../../utils/ckeditorerror.js';
 
 /**

+ 0 - 8
packages/ckeditor5-engine/src/model/delta/delta.jsdoc

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine.model.delta
- */

+ 4 - 0
packages/ckeditor5-engine/src/model/document.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/document
+ */
+
 // Load all basic deltas and transformations, they register themselves, but they need to be imported somewhere.
 import deltas from './delta/basic-deltas.js'; // jshint ignore:line
 import transformations from './delta/basic-transformations.js'; // jshint ignore:line

+ 4 - 0
packages/ckeditor5-engine/src/model/documentfragment.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/documentfragment
+ */
+
 import NodeList from './nodelist.js';
 import Element from './element.js';
 import Text from './text.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/element.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/element
+ */
+
 import Node from './node.js';
 import NodeList from './nodelist.js';
 import Text from './text.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/history.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/history
+ */
+
 import CKEditorError from '../../utils/ckeditorerror.js';
 
 /**

+ 0 - 10
packages/ckeditor5-engine/src/model/item.jsdoc

@@ -1,10 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * Item is a {@link engine.model.Node Node} or {engine.model.TextProxy TextProxy}.
- *
- * @typedef {engine.model.Node|engine.model.TextProxy} engine.model.Item
- */

+ 4 - 0
packages/ckeditor5-engine/src/model/liveposition.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/liveposition
+ */
+
 import RootElement from './rootelement.js';
 import Position from './position.js';
 import Range from './range.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/liverange.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/liverange
+ */
+
 import Range from './range.js';
 import EmitterMixin from '../../utils/emittermixin.js';
 import mix from '../../utils/mix.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/liveselection.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/liveselection
+ */
+
 import Position from './position.js';
 import Range from './range.js';
 import LiveRange from './liverange.js';

+ 0 - 8
packages/ckeditor5-engine/src/model/model.jsdoc

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine.model
- */

+ 4 - 0
packages/ckeditor5-engine/src/model/node.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/node
+ */
+
 import toMap from '../../utils/tomap.js';
 import CKEditorError from '../../utils/ckeditorerror.js';
 

+ 4 - 0
packages/ckeditor5-engine/src/model/nodelist.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/nodelist
+ */
+
 import Node from './node.js';
 import CKEditorError from '../../utils/ckeditorerror.js';
 

+ 0 - 9
packages/ckeditor5-engine/src/model/operation/operation.jsdoc

@@ -1,9 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * Core &rarr; model &rarr; Operation namespace (`engine.model.operation`).
- * @namespace engine.model.operation
- */

+ 4 - 0
packages/ckeditor5-engine/src/model/position.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/position
+ */
+
 import DocumentFragment from './documentfragment.js';
 import Element from './element.js';
 import last from '../../utils/lib/lodash/last.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/range.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/range
+ */
+
 import Position from './position.js';
 import TreeWalker from './treewalker.js';
 import compareArrays from '../../utils/comparearrays.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/rootelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/rootelement
+ */
+
 import Element from './element.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/model/schema.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/schema
+ */
+
 import Position from './position.js';
 import Element from './element.js';
 import clone from '../../utils/lib/lodash/clone.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/selection.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/selection
+ */
+
 import Position from './position.js';
 import Range from './range.js';
 import EmitterMixin from '../../utils/emittermixin.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/text.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/text
+ */
+
 import Node from './node.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/model/textproxy.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/textproxy
+ */
+
 import CKEditorError from '../../utils/ckeditorerror.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/model/treewalker.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/treewalker
+ */
+
 import Text from './text.js';
 import TextProxy from './textproxy.js';
 import Element from './element.js';

+ 4 - 0
packages/ckeditor5-engine/src/model/writer.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/model/writer
+ */
+
 import Node from './node.js';
 import Text from './text.js';
 import TextProxy from './textproxy.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/attributeelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/attributeelement
+ */
+
 import Element from './element.js';
 
 // Default attribute priority.

+ 4 - 0
packages/ckeditor5-engine/src/view/containerelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/containerelement
+ */
+
 import Element from './element.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/view/document.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/document
+ */
+
 import Selection from './selection.js';
 import Renderer from './renderer.js';
 import DomConverter from './domconverter.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/documentfragment.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/documentfragment
+ */
+
 import Text from './text.js';
 import mix from '../../utils/mix.js';
 import isIterable from '../../utils/isiterable.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/domconverter.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/domconverter
+ */
+
 /* globals Range, Node, NodeFilter */
 
 import ViewText from './text.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/editableelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/editableelement
+ */
+
 import ContainerElement from './containerelement.js';
 
 import mix from '../../utils/mix.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/element.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/element
+ */
+
 import Node from './node.js';
 import Text from './text.js';
 import objectToMap from '../../utils/objecttomap.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/emptyelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/emptyelement
+ */
+
 import Element from './element.js';
 import CKEditorError from '../../utils/ckeditorerror.js';
 

+ 4 - 0
packages/ckeditor5-engine/src/view/filler.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/filler
+ */
+
 /* globals window, Range, Text */
 
 import { keyCodes } from '../../utils/keyboard.js';

+ 0 - 10
packages/ckeditor5-engine/src/view/item.jsdoc

@@ -1,10 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * Item is a {@link engine.view.Node Node} or {engine.view.TextProxy TextProxy}.
- *
- * @typedef {engine.view.Node|engine.view.TextProxy} engine.view.Item
- */

+ 4 - 0
packages/ckeditor5-engine/src/view/matcher.js

@@ -4,6 +4,10 @@
  */
 
 /**
+ * @module engine/view/matcher
+ */
+
+/**
  * View matcher class.
  * Instance of this class can be used to find {@link engine.view.Element elements} that match given pattern.
  *

+ 4 - 0
packages/ckeditor5-engine/src/view/node.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/node
+ */
+
 import CKEditorError from '../../utils/ckeditorerror.js';
 import EmitterMixin from '../../utils/emittermixin.js';
 import mix from '../../utils/mix.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/position.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/position
+ */
+
 import Text from './text.js';
 import TextProxy from './textproxy.js';
 

+ 4 - 0
packages/ckeditor5-engine/src/view/range.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/range
+ */
+
 import Position from './position.js';
 import TreeWalker from './treewalker.js';
 

+ 4 - 0
packages/ckeditor5-engine/src/view/renderer.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/renderer
+ */
+
 import ViewText from './text.js';
 import ViewElement from './element.js';
 import ViewPosition from './position.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/rooteditableelement.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/rooteditableelement
+ */
+
 import EditableElement from './editableelement.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/view/selection.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/selection
+ */
+
 import CKEditorError from '../../utils/ckeditorerror.js';
 import Range from './range.js';
 import Position from './position.js';

+ 4 - 0
packages/ckeditor5-engine/src/view/text.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/text
+ */
+
 import Node from './node.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/view/textproxy.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/textproxy
+ */
+
 import CKEditorError from '../../utils/ckeditorerror.js';
 
 /**

+ 4 - 0
packages/ckeditor5-engine/src/view/treewalker.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/treewalker
+ */
+
 import Element from './element.js';
 import Text from './text.js';
 import TextProxy from './textproxy.js';

+ 0 - 8
packages/ckeditor5-engine/src/view/view.jsdoc

@@ -1,8 +0,0 @@
-/**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * @namespace engine.view
- */

+ 4 - 0
packages/ckeditor5-engine/src/view/writer.js

@@ -3,6 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * @module engine/view/writer
+ */
+
 import Position from './position.js';
 import ContainerElement from './containerelement.js';
 import AttributeElement from './attributeelement.js';