add recurisve insertionsort jsdoc

AndreyGeonya · AndreyGeonya · commit 35c0cdbd8f47 · 2015-01-15T18:08:24.000+02:00
diff --git a/src/sorting/recursive-insertionsort.js b/src/sorting/recursive-insertionsort.js
@@ -6,13 +6,25 @@
   }
 
   /**
-   * Recursive version of insertionsort. Complexity O(n^2).
+   * Recursive version of insertion sort.<br><br>
+   * Time complexity: O(N^2).
+   *
+   * @example
+   *
+   * var sort = require('path-to-algorithms/src/sorting/'+
+   * 'recursive-insertionsort').recursiveInsertionSort;
+   * console.log(sort([2, 5, 1, 0, 4])); // [ 0, 1, 2, 4, 5 ]
    *
    * @public
-   * @param {array} array Input array
-   * @param {number} [max] Index of the element which place we should find
-   *                       in the current function call
-   */
+   * @module sorting/recursive-insertionsort
+   * @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.
+   * @param {Number} max Optional. Index of the element which place
+   * we should find in the current function call.
+   * @return {Array} Sorted array.
+   */   
   function recursiveInsertionSort(array, cmp, max) {
     cmp = cmp || compare;
     if (max <= 0) {
@@ -32,4 +44,4 @@
 
   exports.recursiveInsertionSort = recursiveInsertionSort;
 
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);
