Browse Source

Docs: Improved element#is documentation. Closes #863.

Aleksander Nowodzinski 8 years ago
parent
commit
b275f88474
1 changed files with 11 additions and 1 deletions
  1. 11 1
      packages/ckeditor5-engine/src/model/element.js

+ 11 - 1
packages/ckeditor5-engine/src/model/element.js

@@ -83,9 +83,19 @@ export default class Element extends Node {
 	/**
 	 * Checks whether given model tree object is of given type.
 	 *
+	 *		obj.name; // 'listItem'
+	 *		obj instanceof Element; // true
+	 *
+	 *		obj.is( 'element' ); // true
+	 *		obj.is( 'listItem' ); // true
+	 *		obj.is( 'element', 'listItem' ); // true
+	 *		obj.is( 'text' ); // false
+	 *		obj.is( 'element', 'image' ); // false
+	 *
 	 * Read more in {@link module:engine/model/node~Node#is}.
 	 *
-	 * @param {String} type
+	 * @param {String} type Type to check when `name` parameter is present.
+	 * Otherwise, it acts like the `name` parameter.
 	 * @param {String} [name] Element name.
 	 * @returns {Boolean}
 	 */