UNPKG

crojsdoc

Version:

A documentation generator for JavaScript and CoffeeScript

croquiscom.github.com/crojsdoc

croquiscom/crojsdoc

118 lines (111 loc) • 2.99 kB
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{collect} = require '../..' {expect} = require 'chai' describe 'indent', -> it '2 spaces', -> result = collect [ { path: 'simple.coffee', file: 'simple.coffee', data: """ ## # A simple class class Simple ## # Create an instance @create: (name) -> """ } ] expect(result.classes).to.have.length 1 expect(result.classes[0].properties).to.have.length 1 expect(result.classes[0].properties[0].description).to.be.eql summary: '<p>Create an instance</p>\n' body: '' full: '<p>Create an instance</p>\n' it '2 spaces (block comment)', -> result = collect [ { path: 'simple.coffee', file: 'simple.coffee', data: """ ### # A simple class ### class Simple ### # Create an instance ### @create: (name) -> """ } ] expect(result.classes).to.have.length 1 expect(result.classes[0].properties).to.have.length 1 expect(result.classes[0].properties[0].description).to.be.eql summary: '<p>Create an instance</p>\n' body: '' full: '<p>Create an instance</p>\n' it '4 spaces', -> result = collect [ { path: 'simple.coffee', file: 'simple.coffee', data: """ ## # A simple class class Simple ## # Create an instance @create: (name) -> """ } ] expect(result.classes).to.have.length 1 expect(result.classes[0].properties).to.have.length 1 expect(result.classes[0].properties[0].description).to.be.eql summary: '<p>Create an instance</p>\n' body: '' full: '<p>Create an instance</p>\n' it '4 spaces (block comment)', -> result = collect [ { path: 'simple.coffee', file: 'simple.coffee', data: """ ### # A simple class ### class Simple ### # Create an instance ### @create: (name) -> """ } ] expect(result.classes).to.have.length 1 expect(result.classes[0].properties).to.have.length 1 expect(result.classes[0].properties[0].description).to.be.eql summary: '<p>Create an instance</p>\n' body: '' full: '<p>Create an instance</p>\n' it '1 tab', -> result = collect [ { path: 'simple.coffee', file: 'simple.coffee', data: """ ## # A simple class class Simple ## # Create an instance @create: (name) -> """ } ] expect(result.classes).to.have.length 1 expect(result.classes[0].properties).to.have.length 1 expect(result.classes[0].properties[0].description).to.be.eql summary: '<p>Create an instance</p>\n' body: '' full: '<p>Create an instance</p>\n' it '1 tab (block comment)', -> result = collect [ { path: 'simple.coffee', file: 'simple.coffee', data: """ ### # A simple class ### class Simple ### # Create an instance ### @create: (name) -> """ } ] expect(result.classes).to.have.length 1 expect(result.classes[0].properties).to.have.length 1 expect(result.classes[0].properties[0].description).to.be.eql summary: '<p>Create an instance</p>\n' body: '' full: '<p>Create an instance</p>\n'