UNPKG

doks

Version:

A configurable, bring-your-own-template documentation generator aimed for user and developer documentation based on source code.

github.com/kellyirc/doks

kellyirc/doks

37 lines (32 loc) • 681 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/*** * @desc This class does math-like things. * * @name MathExample * @type Class */ /*** * @desc Adds two numbers together. Here, we specify the type of the parameters. * * @name add * @type Function * @param {Number} a (The first number) * @param {Number} b (The second number) * @return {Number} a+b (The result of a+b) */ /*** * Divide two numbers. * This is a multiline message spanning two lines. * * @param a (The first number) * @param b (The second number) * @return a+b */ /*** * @desc Multiply two numbers. * This is a multiline message spanning * 3 lines. * * @param a (The first number) * @param b (The second number) * @return a+b */