Browse Source

Improved docs.

Oskar Wróbel 8 years ago
parent
commit
f74c3eaf80

+ 2 - 2
packages/ckeditor5-engine/src/conversion/modelconversiondispatcher.js

@@ -110,7 +110,7 @@ export default class ModelConversionDispatcher {
 	/**
 	 * Creates a `ModelConversionDispatcher` that operates using passed API.
 	 *
-	 * @param {module:engine/model/document~Document} model Data model.
+	 * @param {module:engine/model/model~Model} model Data model.
 	 * @param {Object} [conversionApi] Interface passed by dispatcher to the events callbacks.
 	 */
 	constructor( model, conversionApi = {} ) {
@@ -118,7 +118,7 @@ export default class ModelConversionDispatcher {
 		 * Data model instance bound with this dispatcher.
 		 *
 		 * @private
-		 * @member {module:engine/model/document~Document}
+		 * @member {module:engine/model/model~Model}
 		 */
 		this._model = model;
 

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

@@ -69,7 +69,7 @@ getData._stringify = stringify;
 /**
  * Sets the contents of the {@link module:engine/model/document~Document Document} provided as HTML-like string.
  *
- * **Note:** Remember to register elements in {@link module:engine/model/document~Document#schema document's schema} before inserting them.
+ * **Note:** Remember to register elements in {@link module:engine/model/model~Model#schema model's schema} before inserting them.
  *
  * **Note:** To create {@link module:engine/model/text~Text text} node witch containing attributes use:
  *

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

@@ -17,8 +17,8 @@ import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable';
  * can be seen as siblings. In other words, it is a detached part of model tree, without a root.
  *
  * DocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection
- * will be set to the {@link module:engine/model/document~Document#markers document markers} by a
- * {@linkTODO module:engine/model/writer~writer.insert} function.
+ * will be set to the {@link module:engine/model/model~Model#markers model markers} by a
+ * {@link module:engine/model/writer~Writer#insert} function.
  */
 export default class DocumentFragment {
 	/**
@@ -30,10 +30,10 @@ export default class DocumentFragment {
 	constructor( children ) {
 		/**
 		 * DocumentFragment static markers map. This is a list of names and {@link module:engine/model/range~Range ranges}
-		 * which will be set as Markers to {@link module:engine/model/document~Document#markers document markers collection}
+		 * which will be set as Markers to {@link module:engine/model/model~Model#markers model markers collection}
 		 * when DocumentFragment will be inserted to the document.
 		 *
-		 * @member {Map<String, {module:engine/model/range~Range}>} module:engine/model/documentfragment~DocumentFragment#markers
+		 * @member {Map<String,module:engine/model/range~Range>} module:engine/model/documentfragment~DocumentFragment#markers
 		 */
 		this.markers = new Map();
 

+ 1 - 1
packages/ckeditor5-engine/src/model/documentselection.js

@@ -52,7 +52,7 @@ export default class DocumentSelection extends Selection {
 	 * Creates an empty live selection for given {@link module:engine/model/document~Document}.
 	 *
 	 * @param {module:engine/model/document~Document} document Document which owns this selection.
-	 * @param {module:engine/model/model~Model} model
+	 * @param {module:engine/model/model~Model} model Data model.
 	 */
 	constructor( document, model ) {
 		super();

+ 1 - 1
packages/ckeditor5-engine/src/model/node.js

@@ -17,7 +17,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  *
  * **Note:** If a node is detached from the model tree, you can manipulate it using it's API.
  * However, it is **very important** that nodes already attached to model tree should be only changed through
- * {@link module:engine/model/document~Document#batch Batch API}.
+ * {@link module:engine/model/writer~Writer Writer API}.
  *
  * Changes done by `Node` methods, like {@link module:engine/model/element~Element#insertChildren insertChildren} or
  * {@link module:engine/model/node~Node#setAttribute setAttribute}

+ 1 - 1
packages/ckeditor5-engine/src/model/text.js

@@ -15,7 +15,7 @@ import Node from './node';
  * **Important:** see {@link module:engine/model/node~Node} to read about restrictions using `Text` and `Node` API.
  *
  * **Note:** keep in mind that `Text` instances might indirectly got removed from model tree when model is changed.
- * This happens when {@linkTODO module:engine/model/writer~writer model writer} is used to change model and the text node is merged with
+ * This happens when {@link module:engine/model/writer~Writer model writer} is used to change model and the text node is merged with
  * another text node. Then, both text nodes are removed and a new text node is inserted into the model. Because of
  * this behavior, keeping references to `Text` is not recommended. Instead, consider creating
  * {@link module:engine/model/liveposition~LivePosition live position} placed before the text node.

+ 1 - 1
packages/ckeditor5-engine/src/model/textproxy.js

@@ -28,7 +28,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  * parameter of methods.
  *
  * **Note:** `TextProxy` is a readonly interface. If you want to perform changes on model data represented by a `TextProxy`
- * use {@linkTODO module:engine/model/writer~writer model writer API}.
+ * use {@link module:engine/model/writer~Writer model writer API}.
  *
  * **Note:** `TextProxy` instances are created on the fly, basing on the current state of model. Because of this, it is
  * highly unrecommended to store references to `TextProxy` instances. `TextProxy` instances are not refreshed when

+ 1 - 1
packages/ckeditor5-engine/src/model/writer.js

@@ -710,7 +710,7 @@ export default class Writer {
 	 *
 	 * If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance
 	 * is passed), `range` parameter may be omitted. In this case marker will not be updated in
-	 * {@link module:engine/model/document~Document#markers document marker collection}. However the marker will be added to
+	 * {@link module:engine/model/model~Model#markers document marker collection}. However the marker will be added to
 	 * the document history. This may be important for other features, like undo. From document history point of view, it will
 	 * look like the marker was created and added to the document at the moment when it is set using this method.
 	 *