Tinker with doclets.io

Author: richrdkng

src/js-partial-foreach.js

@@ -69,94 +69,52 @@
          *
          * @static
          * @memberOf js/partial/foreach
-         *
-         * @property {boolean} [checkArguments=true]
-         *     Determines whether "foreach" should check the number of arguments in the callback function.
-         *     If it is enabled and:
-         *      - when the callback function has one argument, "foreach" will
-         *        pass one argument to the callback function, which will contain
-         *        the actual **value** of the container object.
-         *
-         *      - when the callback function has two arguments, "foreach" will
-         *        pass two arguments to the callback function, the first will be
-         *        the actual **key**, the second will be the
-         *        actual **value** of the container object.
-         *
-         *     If it is disabled, always two arguments will be passed to the
-         *     callback function, the first will be the actual **key**,
-         *     the second will be the actual **value** of the container object.
-         *
-         * @property {boolean} [checkOwnProperty=true]
-         *     Determines whether "foreach" should check whether the container has
-         *     the current key as an own property via containerObject.hasOwnProperty(key).
-         *
-         *     If it is enabled, only those key => value pairs will be passed to the callback function,
-         *     which are own properties of the container object.
-         *
-         *     If it is disabled, every key => value of the container object will be passed to the callback function.
-         *
-         * @property {boolean} [castArrayIndex=true]
-         *     Determines whether "foreach" should cast the indices of the array-like container object
-         *     to integers (in {number}).
-         *
-         *     If it is enabled, when and **only when** two arguments (key => value) will be passed to
-         *     the callback function, the first argument (key) will be cast to an integer (in {number}).
-         *
-         *     If it is disabled, no change and/or cast will occur on the first (key) argument.
          */
         config = {
-            checkArguments   : true,
-            checkOwnProperty : true,
-            castArrayIndex   : true
-        },
-
-        /**
-         * @typedef {Object}
-         *
-         * @static
-         * @memberOf js/partial/foreach
-         */
-        config2 = {
             /**
              * @property {boolean} [checkArguments=true]
-             *     Determines whether "foreach" should check the number of arguments in the callback function.
-             *     If it is enabled and:
-             *      - when the callback function has one argument, "foreach" will
-             *        pass one argument to the callback function, which will contain
-             *        the actual **value** of the container object.
              *
-             *      - when the callback function has two arguments, "foreach" will
-             *        pass two arguments to the callback function, the first will be
-             *        the actual **key**, the second will be the
-             *        actual **value** of the container object.
+             * Determines whether "foreach" should check the number of arguments in the callback function.
+             * If it is enabled and:
+             *   - when the callback function has one argument, "foreach" will
+             *     pass one argument to the callback function, which will contain
+             *     the actual **value** of the container object.
+             *
+             *   - when the callback function has two arguments, "foreach" will
+             *     pass two arguments to the callback function, the first will be
+             *     the actual **key**, the second will be the
+             *     actual **value** of the container object.
              *
-             *     If it is disabled, always two arguments will be passed to the
-             *     callback function, the first will be the actual **key**,
-             *     the second will be the actual **value** of the container object.
+             * If it is disabled, always two arguments will be passed to the
+             * callback function, the first will be the actual **key**,
+             * the second will be the actual **value** of the container object.
              */
             checkArguments   : true,
 
             /**
              * @property {boolean} [checkOwnProperty=true]
-             *     Determines whether "foreach" should check whether the container has
-             *     the current key as an own property via containerObject.hasOwnProperty(key).
+             * @type {boolean}
              *
-             *     If it is enabled, only those key => value pairs will be passed to the callback function,
-             *     which are own properties of the container object.
+             * Determines whether "foreach" should check whether the container has
+             * the current key as an own property via containerObject.hasOwnProperty(key).
              *
-             *     If it is disabled, every key => value of the container object will be passed to the callback function.
+             * If it is enabled, only those key => value pairs will be passed to the callback function,
+             * which are own properties of the container object.
+             *
+             * If it is disabled, every key => value of the container object will be passed to the callback function.
              */
             checkOwnProperty : true,
 
             /**
              * @property {boolean} [castArrayIndex=true]
-             *     Determines whether "foreach" should cast the indices of the array-like container object
-             *     to integers (in {number}).
              *
-             *     If it is enabled, when and **only when** two arguments (key => value) will be passed to
-             *     the callback function, the first argument (key) will be cast to an integer (in {number}).
+             * Determines whether "foreach" should cast the indices of the array-like container object
+             * to integers (in {number}).
+             *
+             * If it is enabled, when and **only when** two arguments (key => value) will be passed to
+             * the callback function, the first argument (key) will be cast to an integer (in {number}).
              *
-             *     If it is disabled, no change and/or cast will occur on the first (key) argument.
+             * If it is disabled, no change and/or cast will occur on the first (key) argument.
              */
             castArrayIndex   : true
         },