浏览代码

API docs fixes.

Piotrek Koszuliński 9 年之前
父节点
当前提交
cf968be388

+ 2 - 2
packages/ckeditor5-engine/src/view/attributeelement.js

@@ -41,7 +41,7 @@ export default class AttributeElement extends Element {
 		this.priority = DEFAULT_PRIORITY;
 
 		/**
-		 * Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if block filler is not needed.
+		 * Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
 		 *
 		 * @method #getFillerOffset
 		 * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
@@ -85,7 +85,7 @@ export default class AttributeElement extends Element {
  */
 AttributeElement.DEFAULT_PRIORITY = DEFAULT_PRIORITY;
 
-// Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if block filler is not needed.
+// Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
 //
 // @returns {Number|null} Block filler offset or `null` if block filler is not needed.
 function getFillerOffset() {

+ 2 - 2
packages/ckeditor5-engine/src/view/containerelement.js

@@ -54,7 +54,7 @@ export default class ContainerElement extends Element {
 		super( name, attrs, children );
 
 		/**
-		 * Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if block filler is not needed.
+		 * Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
 		 *
 		 * @method #getFillerOffset
 		 * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
@@ -63,7 +63,7 @@ export default class ContainerElement extends Element {
 	}
 }
 
-// Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if block filler is not needed.
+// Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
 //
 // @returns {Number|null} Block filler offset or `null` if block filler is not needed.
 function getFillerOffset() {

+ 3 - 2
packages/ckeditor5-engine/src/view/element.js

@@ -614,7 +614,8 @@ export default class Element extends Node {
 	}
 
 	/**
-	 * Sets a custom property.
+	 * Sets a custom property. Unlike attributes, custom properties are not rendered to the DOM,
+	 * so they can be used to add special data to elements.
 	 *
 	 * @param {String|Symbol} key
 	 * @param {*} value
@@ -654,7 +655,7 @@ export default class Element extends Node {
 	}
 
 	/**
-	 * Returns block {@link module:engine/view/filter~Filter filler} offset or `null` if block filler is not needed.
+	 * Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
 	 *
 	 * @abstract
 	 * @method module:engine/view/element~Element#getFillerOffset