Browse Source

API docs: Cleaned up Iterable/Iterator/Generator confusion. See https://github.com/ckeditor/ckeditor5/issues/755. [skip ci]

Piotrek Koszuliński 8 years ago
parent
commit
53fc517400
1 changed files with 3 additions and 1 deletions
  1. 3 1
      packages/ckeditor5-utils/src/collection.js

+ 3 - 1
packages/ckeditor5-utils/src/collection.js

@@ -603,7 +603,9 @@ export default class Collection {
 	}
 	}
 
 
 	/**
 	/**
-	 * Collection iterator.
+	 * Iterable interface.
+	 *
+	 * @returns {Iterable.<*>}
 	 */
 	 */
 	[ Symbol.iterator ]() {
 	[ Symbol.iterator ]() {
 		return this._items[ Symbol.iterator ]();
 		return this._items[ Symbol.iterator ]();