Add JSdocs

lib/defaults.js

@@ -1,5 +1,11 @@
 var _ = require('lodash');
 
+/**
+ * Sets options
+ * @param {Object} [options]
+ * @param {Number} [options.maxDepth]
+ * returns {Object}
+ */
  module.exports = function (options) {
     return _.defaults(options || {}, {
         maxDepth: 6

lib/index.js

@@ -1,6 +1,18 @@
 var getToc = require('./toc'),
     defaults = require('./defaults');
 
+/**
+ * Inserts a TOC object into a source
+ * @param {String} source
+ * @param {Object} [toc]
+ * @param {Number} [toc.index]
+ * @param {String} [toc.data]
+ * @param {Array}  [toc.headers]
+ * @param {Object} [toc.headers[i]]
+ * @param {Number} [toc.headers[i].index]
+ * @param {String} [toc.headers[i].href]
+ * @returns {String}
+ */
 function insertToc(source, toc) {
     if (toc.index === -1) return source;
 
@@ -18,6 +30,13 @@ function insertToc(source, toc) {
     return source;
 }
 
+/**
+ * Generates a TOC (Table Of Contents) for a given source from a place where the HTML comment <!-- TOC --> was found
+ * @param {String} source
+ * @param {Object} [opts]
+ * @param {Number} [opts.maxDepth]
+ * @param {Function} cb
+ */
 module.exports = function (source, opts, cb) {
     var callback,
         options;

lib/log.js

@@ -1,5 +1,9 @@
 require('colors');
 
+/**
+ * Logs which are used in 'cli.js'
+ * @param {String} source
+ */
 module.exports = {
     successMsg: function (source) {
         console.log('The TOC was ' + 'successfully'.bold.green + ' generated for the file ' + source.bold);

lib/toc.js

@@ -1,6 +1,18 @@
 var marked = require('marked'),
     utils = require('./utils');
 
+/**
+ * Generates a TOC object
+ * @param {String} source
+ * @param {Object} [options]
+ * @param {Number} [options.maxDepth]
+ * @returns {Object} [toc]
+ * @returns {Number} [toc.index]
+ * @returns {String} [toc.data]
+ * @returns {Array}  [toc.headers]
+ * @returns {Number} [toc.headers[i].index]
+ * @returns {String} [toc.headers[i].href]
+ */
 module.exports = function (source, options) {
     var toc = {
             index: -1,

lib/utils.js

@@ -1,5 +1,10 @@
 var specialSymbols = new RegExp('[^A-Za-zА-Яа-я0-9_\\- ]', 'g');
 
+/**
+ * Screens backslashes for special symbols
+ * @param {String} text
+ * @returns {String}
+ */
 function _screenBackSlashes(text) {
     text = text.split('');
 
@@ -12,10 +17,15 @@ function _screenBackSlashes(text) {
     return text.join('');
 }
 
-function getHref(text) {
-    var invalidSymbols = text.match(specialSymbols) || [];
+/**
+ * Returns a href for a given header which should be added in a TOC element
+ * @param {String} headerText
+ * @returns {String}
+ */
+function getHref(headerText) {
+    var invalidSymbols = headerText.match(specialSymbols) || [];
 
-    var href = text.toLowerCase().replace(/( )/g, '-').split('');
+    var href = headerText.toLowerCase().replace(/( )/g, '-').split('');
 
     for (var i = 0; i < invalidSymbols.length; i++) {
         href.splice(href.indexOf(invalidSymbols[i]), 1);
@@ -26,18 +36,29 @@ function getHref(text) {
     return href ? href : 'href';
 }
 
-function getIndent(usedHeaders, depth) {
+/**
+ * Returns an indent of a given depth in a TOC
+ * @param {Array} usedHeaders
+ * @param {Number} currentDepth
+ * @return {String}
+ */
+function getIndent(usedHeaders, currentDepth) {
     for (var i = 0; i < usedHeaders.length; i++) {
-        if (usedHeaders[i].depth < depth) {
+        if (usedHeaders[i].depth < currentDepth) {
             return usedHeaders[i].indent + '  ';
         }
     }
 
     return '';
 }
 
-function getHeaderRegExp(header) {
-    var screenedHeader = _screenBackSlashes(header);
+/**
+ * Returns a regular expression which matches a given header
+ * @param {String} headerText
+ * @returns {RegExp}
+ */
+function getHeaderRegExp(headerText) {
+    var screenedHeader = _screenBackSlashes(headerText);
 
     return new RegExp('\\n(#+( )*' + screenedHeader + '( )*#*)|(( )*' + screenedHeader + '\\n(-|=)+' + ')\\n');
 }