-
Notifications
You must be signed in to change notification settings - Fork 0
/
docco.html
147 lines (99 loc) · 4.06 KB
/
docco.html
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html>
<html>
<head>
<title>The Core Code</title>
<meta charset="UTF-8">
<link rel="stylesheet" media="all" href="public/stylesheets/normalize.css" />
<link rel="stylesheet" media="all" href="docs/docco.css" />
</head>
<body>
<div class="container">
<div class="page">
<div class="header">
<h1 id="the-core-code">The Core Code</h1>
<p>This file sets up the core API for the application.
First we require our internal dependencies.</p>
<div class='highlight'><pre><span class="hljs-keyword">import</span> parse <span class="hljs-keyword">from</span> <span class="hljs-string">"./parse"</span>;
<span class="hljs-keyword">import</span> format <span class="hljs-keyword">from</span> <span class="hljs-string">"./format"</span>;
<span class="hljs-keyword">import</span> <span class="hljs-built_in">document</span> <span class="hljs-keyword">from</span> <span class="hljs-string">"./document"</span>;
<span class="hljs-keyword">import</span> cli <span class="hljs-keyword">from</span> <span class="hljs-string">"./cli"</span>;
<span class="hljs-keyword">import</span> {version} <span class="hljs-keyword">from</span> <span class="hljs-string">"./cli"</span>;</pre></div>
<div class="toc">
<h3>Table of Contents</h3>
<ol>
<li>
<a class="source" href="cli.html">
lib/cli.js
</a>
</li>
<li>
<a class="source" href="configure.html">
lib/configure.js
</a>
</li>
<li>
<a class="source" href="defaults.html">
lib/defaults.js
</a>
</li>
<li>
<a class="source" href="docco.html">
lib/docco.js
</a>
</li>
<li>
<a class="source" href="document.html">
lib/document.js
</a>
</li>
<li>
<a class="source" href="format.html">
lib/format.js
</a>
</li>
<li>
<a class="source" href="index.html">
lib/index.js
</a>
</li>
<li>
<a class="source" href="languages.html">
lib/languages.js
</a>
</li>
<li>
<a class="source" href="parse.html">
lib/parse.js
</a>
</li>
<li>
<a class="source" href="write.html">
lib/write.js
</a>
</li>
</ol>
</div>
</div>
<p>Then we export our public API.</p>
<div class='highlight'><pre><span class="hljs-keyword">export</span> <span class="hljs-keyword">default</span> {
<span class="hljs-built_in">document</span>,
format,
parse,
cli,
version
};</pre></div>
<p>Also export these as named exports</p>
<div class='highlight'><pre><span class="hljs-keyword">export</span> {
<span class="hljs-built_in">document</span>,
format,
parse,
cli,
version
};</pre></div>
<p>The core function called by the CLI is, unsurprisingly, called <code>cli</code>.
However with it (and the other functions) you can programatically use docco.</p>
<div class="fleur">h</div>
</div>
</div>
</body>
</html>