Skip to content

Commit 2ff808d

Browse files
committed
Added more API docs for CKEDITOR.tools.array members.
1 parent b24993d commit 2ff808d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

core/tools.js

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1625,7 +1625,8 @@
16251625
*/
16261626
array: {
16271627
/**
1628-
* Returns a copy of `array` filtered using `fn` function.
1628+
* Returns a copy of `array` filtered using `fn` function. Any elements that the `fn` will return `false` for
1629+
* will get removed from returned array.
16291630
*
16301631
* var filtered = this.array.filter( [ 0, 1, 2, 3 ], function( value ) {
16311632
* // Leave only values equal or greater than 2.
@@ -1637,6 +1638,9 @@
16371638
* @param {Array} array
16381639
* @param {Function} fn Function that gets called with each `array` item. Any item for that `fn`
16391640
* returned `false`-alike value for will be filtered out of `array`.
1641+
* @param {Mixed} fn.value Currently iterated array value.
1642+
* @param {Number} fn.index The index of currently iterated value in array.
1643+
* @param {Array} fn.array The original array passed as a `array` variable.
16401644
* @param {Mixed} [thisArg=undefined] Context object for `fn`.
16411645
* @returns {Array} Filtered array.
16421646
* @member CKEDITOR.tools.array
@@ -1658,6 +1662,9 @@
16581662
*
16591663
* @param {Array} array An array to be iterated.
16601664
* @param {Function} fn Function called for every `array` element.
1665+
* @param {Mixed} fn.value Currently iterated array value.
1666+
* @param {Number} fn.index The index of currently iterated value in array.
1667+
* @param {Array} fn.array The original array passed as a `array` variable.
16611668
* @param {Mixed} [thisArg=undefined] Context object for `fn`.
16621669
* @member CKEDITOR.tools.array
16631670
*/

0 commit comments

Comments
 (0)