add richarddurstenfeld jsdoc

AndreyGeonya · AndreyGeonya · commit 15ded21bea6f · 2015-01-15T00:56:59.000+02:00
diff --git a/src/shuffle/fisheryates.js b/src/shuffle/fisheryates.js
@@ -11,6 +11,7 @@
    * var shuffle = require('path-to-algorithms/src/' +
    * 'shuffle/fisheryates').shuffle;
    * console.log(shuffle([1, 2, 3, 4, 5])); // shuffled array
+   *
    * @public
    * @module shuffle/fisheryates
    * @param {Array} array Array which should be shuffled.
diff --git a/src/shuffle/richarddurstenfeld.js b/src/shuffle/richarddurstenfeld.js
@@ -1,17 +1,22 @@
 (function (exports) {
+
   'use strict';
 
   /**
    * Shuffle of an array elements.
    * This algorithm is modified version of Fisher-Yates shuffle
-   * algorithm and is introduced by Richard Durstenfeld.
-   */
-
-  /**
-   * Shuffles an array. Complexity O(n).
+   * algorithm and is introduced by Richard Durstenfeld.<br><br>
+   * Time complexity: O(N).
+   *
+   * @example
+   * var shuffle = require('path-to-algorithms/src/shuffle' +
+   * '/richarddurstenfeld').shuffle;
+   * console.log(shuffle([1, 2, 3, 4, 5])); // random shuffled
    *
-   * @param {array} array An array which should be shuffled
-   * @returns {array} Shuffled array
+   * @public
+   * @module shuffle/richarddurstenfeld
+   * @param {Array} array An array which should be shuffled.
+   * @return {Array} Shuffled array.
    */
   function shuffle(array) {
     var arraySize = array.length - 1;
