|
71 | 71 | * @memberOf js/partial/foreach
|
72 | 72 | *
|
73 | 73 | * @property {boolean} [checkArguments=true]
|
74 |
| - * Determines whether "foreach" should check the number of arguments in the callback function. |
75 |
| - * If it is enabled and: |
76 |
| - * - when the callback function has one argument, "foreach" will |
77 |
| - * pass one argument to the callback function, which will contain |
78 |
| - * the actual **value** of the container object. |
| 74 | + * Determines whether "foreach" should check the number of arguments in the callback function. |
| 75 | + * If it is enabled and: |
| 76 | + * - when the callback function has one argument, "foreach" will |
| 77 | + * pass one argument to the callback function, which will contain |
| 78 | + * the actual **value** of the container object. |
79 | 79 | *
|
80 |
| - * - when the callback function has two arguments, "foreach" will |
81 |
| - * pass two arguments to the callback function, the first will be |
82 |
| - * the actual **key**, the second will be the |
83 |
| - * actual **value** of the container object. |
| 80 | + * - when the callback function has two arguments, "foreach" will |
| 81 | + * pass two arguments to the callback function, the first will be |
| 82 | + * the actual **key**, the second will be the |
| 83 | + * actual **value** of the container object. |
84 | 84 | *
|
85 |
| - * If it is disabled, always two arguments will be passed to the |
86 |
| - * callback function, the first will be the actual **key**, |
87 |
| - * the second will be the actual **value** of the container object. |
| 85 | + * If it is disabled, always two arguments will be passed to the |
| 86 | + * callback function, the first will be the actual **key**, |
| 87 | + * the second will be the actual **value** of the container object. |
88 | 88 | *
|
89 | 89 | * @property {boolean} [checkOwnProperty=true]
|
90 |
| - * Determines whether "foreach" should check whether the container has |
91 |
| - * the current key as an own property via containerObject.hasOwnProperty(key). |
| 90 | + * Determines whether "foreach" should check whether the container has |
| 91 | + * the current key as an own property via containerObject.hasOwnProperty(key). |
92 | 92 | *
|
93 |
| - * If it is enabled, only those key => value pairs will be passed to the callback function, |
94 |
| - * which are own properties of the container object. |
| 93 | + * If it is enabled, only those key => value pairs will be passed to the callback function, |
| 94 | + * which are own properties of the container object. |
95 | 95 | *
|
96 |
| - * If it is disabled, every key => value of the container object will be passed to the callback function. |
| 96 | + * If it is disabled, every key => value of the container object will be passed to the callback function. |
97 | 97 | *
|
98 | 98 | * @property {boolean} [castArrayIndex=true]
|
99 |
| - * Determines whether "foreach" should cast the indices of the array-like container object |
100 |
| - * to integers (in {number}). |
| 99 | + * Determines whether "foreach" should cast the indices of the array-like container object |
| 100 | + * to integers (in {number}). |
101 | 101 | *
|
102 |
| - * If it is enabled, when and **only when** two arguments (key => value) will be passed to |
103 |
| - * the callback function, the first argument (key) will be cast to an integer (in {number}). |
| 102 | + * If it is enabled, when and **only when** two arguments (key => value) will be passed to |
| 103 | + * the callback function, the first argument (key) will be cast to an integer (in {number}). |
104 | 104 | *
|
105 |
| - * If it is disabled, no change and/or cast will occur on the first (key) argument. |
| 105 | + * If it is disabled, no change and/or cast will occur on the first (key) argument. |
106 | 106 | */
|
107 | 107 | config = {
|
108 | 108 | checkArguments : true,
|
|
111 | 111 | },
|
112 | 112 |
|
113 | 113 | /**
|
114 |
| - * @typedef {Object} config2 |
| 114 | + * @typedef {Object} |
115 | 115 | *
|
116 | 116 | * @static
|
117 | 117 | * @memberOf js/partial/foreach
|
118 |
| - * |
119 |
| - * @property {boolean} [checkArguments=true] |
120 |
| - * |
121 |
| - * Determines whether "foreach" should check the number of arguments in the callback function. |
122 |
| - * If it is enabled and: |
123 |
| - * - when the callback function has one argument, "foreach" will |
124 |
| - * pass one argument to the callback function, which will contain |
125 |
| - * the actual **value** of the container object. |
126 |
| - * |
127 |
| - * - when the callback function has two arguments, "foreach" will |
128 |
| - * pass two arguments to the callback function, the first will be |
129 |
| - * the actual **key**, the second will be the |
130 |
| - * actual **value** of the container object. |
131 |
| - * |
132 |
| - * If it is disabled, always two arguments will be passed to the |
133 |
| - * callback function, the first will be the actual **key**, |
134 |
| - * the second will be the actual **value** of the container object. |
135 |
| - * |
136 |
| - * @property {boolean} [checkOwnProperty=true] |
137 |
| - * |
138 |
| - * Determines whether "foreach" should check whether the container has |
139 |
| - * the current key as an own property via containerObject.hasOwnProperty(key). |
140 |
| - * |
141 |
| - * If it is enabled, only those key => value pairs will be passed to the callback function, |
142 |
| - * which are own properties of the container object. |
143 |
| - * |
144 |
| - * If it is disabled, every key => value of the container object will be passed to the callback function. |
145 |
| - * |
146 |
| - * @property {boolean} [castArrayIndex=true] |
147 |
| - * |
148 |
| - * Determines whether "foreach" should cast the indices of the array-like container object |
149 |
| - * to integers (in {number}). |
150 |
| - * |
151 |
| - * If it is enabled, when and **only when** two arguments (key => value) will be passed to |
152 |
| - * the callback function, the first argument (key) will be cast to an integer (in {number}). |
153 |
| - * |
154 |
| - * If it is disabled, no change and/or cast will occur on the first (key) argument. |
155 | 118 | */
|
156 | 119 | config2 = {
|
| 120 | + /** |
| 121 | + * @property {boolean} [checkArguments=true] |
| 122 | + * Determines whether "foreach" should check the number of arguments in the callback function. |
| 123 | + * If it is enabled and: |
| 124 | + * - when the callback function has one argument, "foreach" will |
| 125 | + * pass one argument to the callback function, which will contain |
| 126 | + * the actual **value** of the container object. |
| 127 | + * |
| 128 | + * - when the callback function has two arguments, "foreach" will |
| 129 | + * pass two arguments to the callback function, the first will be |
| 130 | + * the actual **key**, the second will be the |
| 131 | + * actual **value** of the container object. |
| 132 | + * |
| 133 | + * If it is disabled, always two arguments will be passed to the |
| 134 | + * callback function, the first will be the actual **key**, |
| 135 | + * the second will be the actual **value** of the container object. |
| 136 | + */ |
157 | 137 | checkArguments : true,
|
158 | 138 |
|
| 139 | + /** |
| 140 | + * @property {boolean} [checkOwnProperty=true] |
| 141 | + * Determines whether "foreach" should check whether the container has |
| 142 | + * the current key as an own property via containerObject.hasOwnProperty(key). |
| 143 | + * |
| 144 | + * If it is enabled, only those key => value pairs will be passed to the callback function, |
| 145 | + * which are own properties of the container object. |
| 146 | + * |
| 147 | + * If it is disabled, every key => value of the container object will be passed to the callback function. |
| 148 | + */ |
159 | 149 | checkOwnProperty : true,
|
160 | 150 |
|
| 151 | + /** |
| 152 | + * @property {boolean} [castArrayIndex=true] |
| 153 | + * Determines whether "foreach" should cast the indices of the array-like container object |
| 154 | + * to integers (in {number}). |
| 155 | + * |
| 156 | + * If it is enabled, when and **only when** two arguments (key => value) will be passed to |
| 157 | + * the callback function, the first argument (key) will be cast to an integer (in {number}). |
| 158 | + * |
| 159 | + * If it is disabled, no change and/or cast will occur on the first (key) argument. |
| 160 | + */ |
161 | 161 | castArrayIndex : true
|
162 | 162 | },
|
163 | 163 |
|
|
0 commit comments