shellsort jsdoc

AndreyGeonya · AndreyGeonya · commit 2dc73ba4608f · 2015-01-15T18:49:49.000+02:00
diff --git a/src/sorting/recursive-insertionsort.js b/src/sorting/recursive-insertionsort.js
@@ -24,7 +24,7 @@
    * @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) {
diff --git a/src/sorting/shellsort.js b/src/sorting/shellsort.js
@@ -5,22 +5,27 @@
     return a - b;
   }
 
-  /**
-   * Shellsort
-   *
-   * Shellsort uses the gaps 701, 301, 132, 57, 23, 10, 4, 1 and uses
-   * insertion sort to sort the sub-arrays which match for the different gaps.
-   */
   var shellSort = (function () {
 
     var gaps = [701, 301, 132, 57, 23, 10, 4, 1];
 
     /**
-     * Shellsort which uses the gaps in the lexical scope of the IIFE.
+     * Shellsort which uses the gaps 701, 301, 132, 57, 23, 10, 4, 1 and
+     * insertion sort to sort sub-arrays which match for the different gaps.
+     *
+     * @example
+     *
+     * var sort = require('path-to-algorithms/src/' +
+     * 'sorting/shellsort').shellSort;
+     * console.log(sort([2, 5, 1, 0, 4])); // [ 0, 1, 2, 4, 5 ]
      *
      * @public
-     * @param {array} array Array which should be sorted
-     * @return {array} Sorted array
+     * @module sorting/shellsort
+     * @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;
