combinations jsdoc

AndreyGeonya · AndreyGeonya · commit 1c8e97547f2b · 2015-01-11T18:33:01.000+02:00
diff --git a/src/combinatorics/cartesianproduct.js b/src/combinatorics/cartesianproduct.js
@@ -23,8 +23,8 @@
      * @return {Array} Cartesian product of provided sets.
      *
      * @example
-     * var product = require('../src/combinatorics/cartesianproduct')
-     * .cartesianProduct;
+     * var product = require('path-to-algorithms/src/combinatorics/' +
+     * 'cartesianproduct').cartesianProduct;
      * var result = product([[1, 2, 3], [3, 2, 1]]);
      * // [ [ 1, 3 ],
      * //   [ 1, 2 ],
diff --git a/src/combinatorics/combinations.js b/src/combinatorics/combinations.js
@@ -15,6 +15,29 @@
       }
     }
 
+    /**
+     * A combination is a way of selecting members from a grouping,
+     * such that (unlike permutations) the order of selection does not matter.
+     * For example given three fruits, say an apple, an orange and a pear,
+     * there are three combinations of two that can be drawn from this set:
+     * an apple and a pear; an apple and an orange; or a pear and an orange.
+     * 
+     * @example
+     * 
+     * var combinations = require('path-to-algorithms/src/' +
+     * 'combinatorics/combinations').combinations;
+     * var result = combinations(['apple', 'orange', 'pear'], 2);
+     * // [['apple', 'orange'],
+     * //  ['apple', 'pear'],
+     * //  ['orange', 'pear']]
+     * console.log(result);
+     * 
+     * @module combinatorics/combinations
+     * @public
+     * @param arr {Array} Set of items.
+     * @param k {Number} Size of each combination.
+     * @return {Array} Returns all combinations.
+     */
     return function (arr, k) {
       res = [];
       combinations(arr, k, 0, 0, []);
@@ -27,4 +50,4 @@
 
   exports.combinations = combinations;
 
-}(typeof exports === 'undefined' ? window : exports));
+}((typeof window === 'undefined') ? module.exports : window));
