Procházet zdrojové kódy

Docs: Added missing docs and prevented errors in other ones.

Piotrek Koszuliński před 8 roky
rodič
revize
4dbd71e6eb

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

@@ -18,7 +18,7 @@ import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable';
  *
  * 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
- * {@link module:engine/model/writer~writer.insert} function.
+ * {@linkTODO module:engine/model/writer~writer.insert} function.
  */
 export default class DocumentFragment {
 	/**

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

@@ -17,6 +17,8 @@ import isIterable from '@ckeditor/ckeditor5-utils/src/isiterable';
  * {@link module:engine/model/element~Element#getChildren child nodes}.
  *
  * **Important**: see {@link module:engine/model/node~Node} to read about restrictions using `Element` and `Node` API.
+ *
+ * @extends {module:engine/model/node~Node}
  */
 export default class Element extends Node {
 	/**

+ 1 - 1
packages/ckeditor5-engine/src/model/item.jsdoc

@@ -8,7 +8,7 @@
  */
 
 /**
- * Item is a {@link module:engine/model/node~Node Node} or {@link module:engine/model/textproxy~TextProxy TextProxy}.
+ * Item is a {@link module:engine/model/node~Node} or {@link module:engine/model/textproxy~TextProxy}.
  *
  * @typedef {module:engine/model/node~Node|module:engine/model/textproxy~TextProxy} module:engine/model/item~Item
  */

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

@@ -16,7 +16,7 @@ import NodeList from '../nodelist';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
 
 /**
- * Contains functions used for composing model tree by {@link module:engine/model/operation~Operation operations}.
+ * Contains functions used for composing model tree by {@link module:engine/model/operation/operation~Operation operations}.
  * Those functions are built on top of {@link module:engine/model/node~Node node}, and it's child classes', APIs.
  *
  * @protected

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

@@ -15,10 +15,12 @@ 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 {@link module:engine/model/writer~writer model writer} is used to change model and the text node is merged with
+ * This happens when {@linkTODO 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.
+ *
+ * @extends {module:engine/model/node~Node}
  */
 export default class Text extends 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 {@link module:engine/model/writer~writer model writer API}.
+ * use {@linkTODO 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