add mergesort jsdoc

AndreyGeonya · AndreyGeonya · commit 0728085c71f2 · 2015-01-15T17:54:04.000+02:00
diff --git a/src/sorting/insertion-binary-sort.js b/src/sorting/insertion-binary-sort.js
@@ -55,4 +55,4 @@
 
   exports.insertionBinarySort = insertionBinarySort;
 
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);
diff --git a/src/sorting/insertionsort.js b/src/sorting/insertionsort.js
@@ -41,4 +41,4 @@
 
   exports.insertionSort = insertionSort;
 
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);
diff --git a/src/sorting/lsd.js b/src/sorting/lsd.js
@@ -48,4 +48,4 @@
 
   exports.lsd = lsd;
 
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);
diff --git a/src/sorting/mergesort.js b/src/sorting/mergesort.js
@@ -75,11 +75,22 @@
     }
 
     /**
-     * Initial call to the mergesort method
+     * Merge sort algorithm.<br><br>
+     * Time complexity: O(N logN).
+     *
+     * @example
+     *
+     * var sort = require('path-to-algorithms/src' +
+     * '/sorting/mergesort').mergesortSort;
+     * console.log(sort([2, 5, 1, 0, 4])); // [ 0, 1, 2, 4, 5 ]
      *
      * @public
-     * @param {array} array The array which will be sorted
-     * @returns {array} Sorted array
+     * @module sorting/mergesort
+     * @param {Array} array Input array.
+     * @param {Function} cmp Optional. A function that defines an
+     * alternative sort order. The function should return a negative,
+     * zero, or positive value, depending on the arguments.
+     * @return {Array} Sorted array.
      */
     return function (array, cmp) {
       cmp = cmp || compare;
@@ -90,4 +101,4 @@
 
   exports.mergeSort = mergeSort;
 
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);
diff --git a/src/sorting/msd.js b/src/sorting/msd.js
@@ -54,12 +54,11 @@
    * @param {Number} d Optional. Digit from which sorting should start.
    * @return {Array} Sorted array.
    */
-
   function msd(arr, d) {
     d = d || 0;
     sort(arr, 0, arr.length - 1, d);
     return arr;
   }
 
   exports.msd = msd;
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);

Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,4 @@`
`55`	`55`
`56`	`56`	`exports.insertionBinarySort = insertionBinarySort;`
`57`	`57`
`58`		`-}(typeof exports === 'undefined' ? window : exports));`
	`58`	`+})(typeof window === 'undefined' ? module.exports : window);`
Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@`
`41`	`41`
`42`	`42`	`exports.insertionSort = insertionSort;`
`43`	`43`
`44`		`-}(typeof exports === 'undefined' ? window : exports));`
	`44`	`+})(typeof window === 'undefined' ? module.exports : window);`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,4 @@`
`48`	`48`
`49`	`49`	`exports.lsd = lsd;`
`50`	`50`
`51`		`-}(typeof exports === 'undefined' ? window : exports));`
	`51`	`+})(typeof window === 'undefined' ? module.exports : window);`