add heapsort jsdoc

AndreyGeonya · AndreyGeonya · commit 756acc393511 · 2015-01-15T15:21:18.000+02:00
diff --git a/src/sorting/heapsort.js b/src/sorting/heapsort.js
@@ -5,20 +5,15 @@
     return a - b;
   }
 
-  /**
-   * The heapsort algorithm. It's complexity is O(nlog n).
-   *
-   * @public
-   */
   var heapSort = (function () {
 
     /**
      * Finds the correct place of given element in given max heap.
      *
      * @private
-     * @param {array} array Array
-     * @param {number} index Index of the element which palce in
-     *                       the max heap should be found.
+     * @param {Array} array Array.
+     * @param {Number} index Index of the element which palce in
+     * the max heap should be found.
      */
     function heapify(array, index, heapSize, cmp) {
       var left = 2 * index + 1;
@@ -45,8 +40,8 @@
      * Builds max heap from given array.
      *
      * @private
-     * @param {array} array Array which should be turned into max heap
-     * @returns {array} array Array turned into max heap
+     * @param {Array} array Array which should be turned into max heap.
+     * @return {Array} array Array turned into max heap.
      */
     function buildMaxHeap(array, cmp) {
       for (var i = Math.floor(array.length / 2); i >= 0; i -= 1) {
@@ -56,11 +51,20 @@
     }
 
     /**
-     * Heapsort. Turns the input array into max heap and after that sorts it.
+     * Heapsort. Turns the input array into max
+     * heap and after that sorts it.<br><br>
+     * Time complexity: O(N log N).
+     *
+     * @example
+     *
+     * var sort = require('path-to-algorithms/src' +
+     * '/sorting/heapsort').heapSort;
+     * console.log(sort([2, 5, 1, 0, 4])); // [ 0, 1, 2, 4, 5 ]
      *
      * @public
-     * @param {array} array Input array
-     * @returns {array} array Sorted array
+     * @module sorting/heapsort
+     * @param {Array} array Input array.
+     * @return {Array} Sorted array.
      */
     return function (array, cmp) {
       cmp = cmp || comparator;
@@ -80,4 +84,4 @@
 
   exports.heapSort = heapSort;
 
-}(typeof exports === 'undefined' ? window : exports));
+})(typeof window === 'undefined' ? module.exports : window);
