upated jsdoc for primes

pvoznenko · pvoznenko · commit e86b9c9d723f · 2015-01-11T17:32:51.000+01:00
diff --git a/doc-config.json b/doc-config.json
@@ -8,7 +8,8 @@
             "./src/graphs/others/",
             "./src/graphs/shortest-path/",
             "./src/graphs/spanning-trees/",
-            "./src/data-structures/"
+            "./src/data-structures/",
+            "./src/primes/"
         ],
         "includePattern": ".+\\.js(doc)?$",
         "excludePattern": "docs"
diff --git a/src/primes/is-prime.js b/src/primes/is-prime.js
@@ -1,17 +1,19 @@
-/**
- * Advanced (optimised) method for checking if provided number is prime
- *
- * For example for number 104743 it should return true, for 104744 - false
- */
 (function (exports) {
   'use strict';
 
   /**
-   * Method will return true if provided number is prime
+   * Advanced (optimised) method for checking if provided number is prime.
+   * For example for number 104743 it should return true, for 104744 - false.
    *
-   * @module primes
-   * @param {Number} number - number that we check on prime
-   * @returns {Boolean}
+   * @module primes/is-prime
+   * @param {Number} number - Number that we check on prime
+   * @returns {Boolean} Will return true if provided number is prime
+   *
+   * @example
+   * var isPrime = require('path/to/primes/is-prime').isPrime;
+   *
+   * console.log(isPrime(7)); // true
+   * console.log(isPrime(18)); // false
    */
   exports.isPrime = function (number) {
     if (number === 1) {
diff --git a/src/primes/prime-factor-tree.js b/src/primes/prime-factor-tree.js
@@ -1,17 +1,21 @@
-/**
- * Method that will return list of all primes for provided number
- *
- * For example for number 18 it should return following list of primes [2, 3, 3]
- */
 (function (exports) {
   'use strict';
 
   /**
-   * Method will list of all primes for provided number
+   * Method will return list of all primes for provided number.
+   * For example for number 18 it should return following list of primes
+   * [2, 3, 3].
    *
-   * @module primes
-   * @param {Number} number
-   * @returns {Array}
+   * @module primes/prime-factor-tree
+   * @param {Number} number - Number for which method will find all primes
+   * @returns {Array} List of available primes for provided number
+   *
+   * @example
+   * var primeFactorTree = require('path/to/primes/prime-factor-tree')
+   * .primeFactorTree;
+   *
+   * console.log(primeFactorTree(18)); // [2, 3, 3]
+   * console.log(primeFactorTree(600851475143)); // [71, 839, 1471, 6857]
    */
   exports.primeFactorTree = function (number) {
     var div = 2,
diff --git a/src/primes/sieve-of-eratosthenes.js b/src/primes/sieve-of-eratosthenes.js
@@ -1,26 +1,27 @@
-/**
- * Sieve of Eratosthenes
- *
- * Simple, ancient algorithm for finding all prime numbers up to any given limit
- *
- * For example for limit 12 it should return following list of primes:
- * [2, 3, 5, 7, 11]
- */
 (function (exports) {
   'use strict';
 
   /**
-   * Returns Sieve of Eratosthenes for specified number
+   * Sieve of Eratosthenes.
    *
-   * Simple, ancient algorithm for finding all prime numbers up to any given
+   * Simple, ancient algorithm for finding all prime numbers up to given limit.
+   *
+   * Returns list of primes up to specified limit.
+   *
+   * For example, for limit 10 it should return following list of primes:
+   * [2, 3, 5, 7]
+   *
+   * @module primes/sieve-of-eratosthenes
+   * @param {Number} limit - Algorithm will returns list of primes up to
+   * specified limit
+   * @returns {Array} Will return list with all prime numbers up to provided
    * limit
    *
-   * @module primes
-   * @param {Number} limit - algorithm will return list with prime numbers up
-   *             to given limit
+   * @example
+   * var sieveOfEratosthenes = require('path/to/primes/sieve-of-eratosthenes')
+   * .sieveOfEratosthenes;
    *
-   * @returns {Array} - will return array with all prime numbers up to
-   *          provided limit
+   * console.log(sieveOfEratosthenes(12)); // [2, 3, 5, 7, 11]
    */
   exports.sieveOfEratosthenes = function (limit) {
     var sieve = [],
