Bladeren bron

Minor changes in samples for is() method.

Mateusz Samsel 6 jaren geleden
bovenliggende
commit
7c1a31b005

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

@@ -94,6 +94,7 @@ export default class Element extends Node {
 	 *		element.is( 'element' ); // -> true
 	 *		element.is( 'node' ); // -> true
 	 *		element.is( 'model:element' ); // -> true
+	 *		element.is( 'model:node' ); // -> true
 	 *
 	 *		element.is( 'view:element' ); // -> false
 	 *		element.is( 'documentSelection' ); // -> false

+ 3 - 2
packages/ckeditor5-engine/src/model/rootelement.js

@@ -58,10 +58,11 @@ export default class RootElement extends Element {
 	 * Checks whether this object is of the given.
 	 *
 	 *		rootElement.is( 'rootElement' ); // -> true
-	 *		rootElement.is( 'model:rootElement' ); // -> true
 	 *		rootElement.is( 'element' ); // -> true
 	 *		rootElement.is( 'node' ); // -> true
+	 *		rootElement.is( 'model:rootElement' ); // -> true
 	 *		rootElement.is( 'model:element' ); // -> true
+	 *		rootElement.is( 'model:node' ); // -> true
 	 *
 	 *		rootElement.is( 'view:element' ); // -> false
 	 *		rootElement.is( 'documentFragment' ); // -> false
@@ -70,7 +71,7 @@ export default class RootElement extends Element {
 	 * {@link module:engine/model/element~Element#name name}:
 	 *
 	 *		rootElement.is( '$root' ); // -> true if this is a $root element
-	 *		rootElement.is( 'element', '$root' ); // -> same as above
+	 *		rootElement.is( 'rootElement', '$root' ); // -> same as above
 	 *		text.is( '$root' ); -> false
 	 *
 	 * {@link module:engine/model/node~Node#is Check the entire list of model objects} which implement the `is()` method.

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

@@ -68,6 +68,7 @@ export default class Text extends Node {
 	 *		text.is( 'text' ); // -> true
 	 *		text.is( 'node' ); // -> true
 	 *		text.is( 'model:text' ); // -> true
+	 *		text.is( 'model:node' ); // -> true
 	 *
 	 *		text.is( 'view:text' ); // -> false
 	 *		text.is( 'documentSelection' ); // -> false
@@ -76,7 +77,6 @@ export default class Text extends Node {
 	 *
 	 * @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}
 	 */
 	is( type ) {