doc

Runtime documentation tool for REPL.

Usage

Have you ever wished you could see docs for the given function right out of the REPL? If so, this tool is for you!

1var doc = require('doc').doc
2doc(doc) // Prints following output:
3
4/*
5function doc(source) { ... }
6-----------------------------------------------
7Prints documentanion of the given function
8*/
9
10// You can also document your own functions:
11
12function compose() {
13  doc: "Returns the composition of a list of functions, where each function"
14     | "consumes the return value of the function that follows. In math"
15     | "terms, composing the functions `f()`, `g()`, and `h()` produces"
16     | "`f(g(h()))`."
17     | "Usage:"
18     | "var greet = function(name) { return 'hi: ' + name }"
19     | "var exclaim = function(statement) { return statement + '!' }"
20     | "var welcome = compose(exclaim, greet)"
21     | "welcome('moe')"
22     | "//> 'hi: moe!'"
23
24  var funcs = Array.prototype.slice.call(arguments)
25  return function composed() {
26    var args = slice.call(arguments)
27    var i = funcs.length
28    while (0 <= --i) args = [ funcs[i].apply(this, args) ]
29    return args[0]
30  }
31}
32
33doc(compose) // Prints following output:
34
35/*
36function compose() { ... }
37-----------------------------------------------
38Returns the composition of a list of functions, where each function
39consumes the return value of the function that follows. In math
40terms, composing the functions `f()`, `g()`, and `h()` produces
41`f(g(h()))`.
42Usage:
43var greet = function(name) { return 'hi: ' + name }
44var exclaim = function(statement) { return statement + '!' }
45var welcome = compose(exclaim, greet)
46welcome('moe')
47//> 'hi: moe!'
48*/
49
50// Alternative way to documenting functions (Not cross platform though):
51
52function sum(a, b) {
53  /**
54  Takes arbitary number of arguments and returns their sum.
55  Usage:
56  sum(7, 2, 8) //> 17
57  **/
58
59  var count = arguments.length, index = 0, value = 0
60  while (index < count) value += arguments[index++]
61  return value
62}
63
64doc(sum) // Prints following output:
65
66/*
67function sum(a, b) { ... }
68-----------------------------------------------
69Takes arbitary number of arguments and returns their sum.
70Usage:
71sum(7, 2, 8) //> 17
72*/
73

Install

npm install doc