lsd and msd jsdoc

AndreyGeonya · AndreyGeonya · commit f79e88fba22c · 2015-01-15T17:46:31.000+02:00
diff --git a/src/sorting/lsd.js b/src/sorting/lsd.js
@@ -2,13 +2,20 @@
   'use strict';
 
   /**
-   * Sorts strings lexicographically.
-   * Complexity O(n*m)
+   * Sorts strings lexicographically.<br><br>
+   * Time complexity: O(N*M) for N keys which have M or fewer digits.
+   *
+   * @example
+   *
+   * var sort = require('../src/sorting/lsd').lsd;
+   * // [ 'aab', 'aaa', 'acc', 'bbb', 'bcc' ]
+   * console.log(sort(['aab', 'bbb', 'aaa', 'acc', 'bcc']));
    *
    * @public
-   * @param {Array} arr Input array
-   * @param {Number} letterIdx Index to start sorting from
-   * @returns {Array} Sorted array
+   * @module sorting/lsd
+   * @param {Array} arr Array which should be sorted.
+   * @param {Number} letterIdx Optional. Index to start sorting from.
+   * @return {Array} Sorted array.
    */
   function lsd(arr, letterIdx) {
     var temp;
diff --git a/src/sorting/msd.js b/src/sorting/msd.js
@@ -37,16 +37,22 @@
 
   /**
    * Sorts given array lexicographically.
-   * The algorithms knows how to treat
-   * differently length strings.
-   * The algorithm is stable.
+   * Algorithms knows how to treat
+   * differently length strings.<br><br>
+   * Algorithm is stable.
+   * Time complexity: O(N*M) for N keys which have M or fewer digits.
    *
-   * Complexity O(n*m)
+   * @example
+   *
+   * var sort = require('../src/sorting/msd').msd;
+   * // [ 'aab', 'aaa', 'acc', 'bbb', 'bcc' ]
+   * console.log(sort(['aab', 'bbb', 'aaa', 'acc', 'bcc']));
    *
    * @public
-   * @param {Array} arr The array, which needs to be sorted
-   * @param {Number} d The digit from which the sorting should start
-   * @return {Array} The sorted array
+   * @module sorting/msd
+   * @param {Array} arr Array which should be sorted.
+   * @param {Number} d Digit from which sorting should start.
+   * @return {Array} Sorted array.
    */
 
   function msd(arr, d) {
