Skip to content

Commit a2ff813

Browse files
carlosmncarlosmn
authored
Merge pull request #34 from tiennou/fixups
Fixups
2 parents 5131700 + 745f555 commit a2ff813

File tree

4 files changed

+253
-251
lines changed

4 files changed

+253
-251
lines changed

‎lib/docurium.rb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,9 @@ def generate_docs(options)
199199

200200
end
201201

202-
# We tally the sigantures in the order they finished, which is
202+
# We tally the signatures in the order they finished, which is
203203
# arbitrary due to the concurrency, so we need to sort them once
204-
# they've finsihed.
204+
# they've finished.
205205
sort_sigs!
206206

207207
project = {
@@ -435,7 +435,7 @@ def update_globals!(data, recs)
435435
# process this type of record
436436
case r[:type]
437437
when :function, :callback
438-
t = r[:type] == :function ? :functions : :callbacks
438+
t = r[:type] == :function ? :functions : :callbacks
439439
data[t][r[:name]] ||= {}
440440
wanted[:functions].each do |k|
441441
next unless r.has_key? k

‎site/css/style.css‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ input.search {
9595
background: url(../images/search_icon.png) 5px 50% no-repeat white;
9696
}
9797

98-
a small {
98+
a small {
9999
font-size: 0.8em;
100100
color: #aaa;
101101
}
102102

103-
h2 small {
103+
h2 small {
104104
font-size: 0.8em;
105105
font-weight: normal;
106106
color: #666;

‎site/index.html‎

Lines changed: 112 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
55
<title>API Documentation</title>
6-
<link href="shared/css/documentation.css" media="screen" rel="stylesheet" type="text/css">
7-
<link href="shared/css/pygments.css" media="screen" rel="stylesheet" type="text/css">
8-
<link href="css/style.css" media="screen" rel="stylesheet" type="text/css">
9-
<script src="shared/js/jquery.js" type="text/javascript"></script>
10-
<script src="js/json2.js" type="text/javascript"></script>
11-
<script src="js/underscore.js" type="text/javascript"></script>
12-
<script src="js/backbone.js" type="text/javascript"></script>
13-
<script src="js/docurium.js" type="text/javascript"></script>
6+
<link href="shared/css/documentation.css" media="screen" rel="stylesheet" type="text/css">
7+
<link href="shared/css/pygments.css" media="screen" rel="stylesheet" type="text/css">
8+
<link href="css/style.css" media="screen" rel="stylesheet" type="text/css">
9+
<script src="shared/js/jquery.js" type="text/javascript"></script>
10+
<script src="js/json2.js" type="text/javascript"></script>
11+
<script src="js/underscore.js" type="text/javascript"></script>
12+
<script src="js/backbone.js" type="text/javascript"></script>
13+
<script src="js/docurium.js" type="text/javascript"></script>
1414

1515
<!-- Changelog -->
1616
<script type="text/template" id="changelog-item-template">
1717
<p>
18-
<ul>
19-
<% _.each(dels, function(elem) { %>
20-
<li class="deletes"><%= elem %></li>
21-
<% }) %>
22-
</ul>
18+
<ul>
19+
<% _.each(dels, function(elem) { %>
20+
<li class="deletes"><%= elem %></li>
21+
<% }) %>
22+
</ul>
2323
</p>
2424
<p>
25-
<ul>
26-
<% _.each(adds, function(elem) { %>
27-
<li class="adds"><a href="#<%= elem.link %>"><%= elem.text %></a></li>
28-
<% }) %>
29-
</ul>
25+
<ul>
26+
<% _.each(adds, function(elem) { %>
27+
<li class="adds"><a href="#<%= elem.link %>"><%= elem.text %></a></li>
28+
<% }) %>
29+
</ul>
3030
</p>
3131
</script>
3232

@@ -35,7 +35,7 @@ <h1>Function Changelog</h1>
3535
<% _.each(versions, function(version) { %>
3636
<h3><%= version.title %></h3>
3737
<div class="changelog">
38-
<%= version.listing %>
38+
<%= version.listing %>
3939
</div>
4040
<% }) %>
4141
</script>
@@ -55,27 +55,27 @@ <h3><%= version.title %></h3>
5555
<!-- Sidebar where the groups and types appear -->
5656
<script type="text/template" id="type-list-template">
5757
<li>
58-
<li><span class="divide"><%= title %></span></li>
59-
<% _.each(elements, function(e) { %>
60-
<li>
61-
<a href="#<%= e.link %>" ref="<%= e.ref %>" class="type", id="typeItem<%= e.name %>">
62-
<%= e.name %>
63-
</a>
64-
</li>
65-
<% }) %>
58+
<li><span class="divide"><%= title %></span></li>
59+
<% _.each(elements, function(e) { %>
60+
<li>
61+
<a href="#<%= e.link %>" ref="<%= e.ref %>" class="type", id="typeItem<%= e.name %>">
62+
<%= e.name %>
63+
</a>
64+
</li>
65+
<% }) %>
6666
</li>
6767
</script>
6868
<script type="text/template" id="file-list-template">
6969
<li>
7070
<h3><a href="#">Functions</a></h3>
7171
<ul>
72-
<% _.each(funs, function(fun, i) { %>
73-
<li>
74-
<a href="#<%= fun.link %>" ref="<%= i %>" class="group" id="groupItem<%= fun.name %>">
75-
<%= fun.name %>&nbsp;<small>(<%= fun.num %>)</small>
76-
</a>
77-
</li>
78-
<% }) %>
72+
<% _.each(funs, function(fun, i) { %>
73+
<li>
74+
<a href="#<%= fun.link %>" ref="<%= i %>" class="group" id="groupItem<%= fun.name %>">
75+
<%= fun.name %>&nbsp;<small>(<%= fun.num %>)</small>
76+
</a>
77+
</li>
78+
<% }) %>
7979
</ul>
8080
</li>
8181
<li>
@@ -85,22 +85,22 @@ <h3><a href="#">Types</a></h3>
8585
<li>
8686
<h3><a href="#">Files</a></h3>
8787
<ul class="hidden">
88-
<% _.each(files, function(file) { %>
89-
<li>
90-
<a target="github" href="<%= file.url %>"><%= file.name %></a>
91-
</li>
92-
<% }) %>
88+
<% _.each(files, function(file) { %>
89+
<li>
90+
<a target="github" href="<%= file.url %>"><%= file.name %></a>
91+
</li>
92+
<% }) %>
9393
</ul>
9494
</li>
9595
<% if (examples.length > 0) { %>
9696
<li>
9797
<h3><a href="#">Examples</a></h3>
9898
<ul>
99-
<% _.each(examples, function(example) { %>
100-
<li>
101-
<a href="<%= example.path %>"><%= example.name %></a>
102-
</li>
103-
<% }) %>
99+
<% _.each(examples, function(example) { %>
100+
<li>
101+
<a href="<%= example.path %>"><%= example.name %></a>
102+
</li>
103+
<% }) %>
104104
</ul>
105105
</li>
106106
<% } %> <!-- if we have examples -->
@@ -109,13 +109,13 @@ <h3><a href="#">Examples</a></h3>
109109
<!-- Listing of the details of a single function -->
110110
<script type="text/template" id="function-args-template">
111111
<table class="funcTable">
112-
<% _.each(args, function(arg) { %>
113-
<tr>
114-
<td valign="top" nowrap="true"><%= arg.link %></td>
115-
<td valign="top" class="var"><%= arg.name %></td>
116-
<td class="comment"><%= arg.comment %></td>
117-
</tr>
118-
<% }) %>
112+
<% _.each(args, function(arg) { %>
113+
<tr>
114+
<td valign="top" nowrap="true"><%= arg.link %></td>
115+
<td valign="top" class="var"><%= arg.name %></td>
116+
<td class="comment"><%= arg.comment %></td>
117+
</tr>
118+
<% }) %>
119119
</table>
120120
</script>
121121
<script type="text/template" id="function-template">
@@ -126,10 +126,10 @@ <h3 class="funcDesc"><%= data.description %></h3>
126126
<div class="returns">
127127
<h3>returns</h3>
128128
<table class="funcTable">
129-
<tr>
130-
<td valign="top"><%= returns.link %></td>
131-
<td class="comment"><%= returns.comment %></td>
132-
</tr>
129+
<tr>
130+
<td valign="top"><%= returns.link %></td>
131+
<td class="comment"><%= returns.comment %></td>
132+
</tr>
133133
</table>
134134
</div>
135135
<div><%= data.comments %></div>
@@ -143,9 +143,9 @@ <h3>signature</h3>
143143
<div class="signatures">
144144
<h3>versions</h3>
145145
<ul>
146-
<% _.each(sigs, function(sig) { %>
147-
<li><a href="<%= sig.url %>" class="<%= sig.klass %>"><%= sig.name %></a></li>
148-
<% }) %>
146+
<% _.each(sigs, function(sig) { %>
147+
<li><a href="<%= sig.url %>" class="<%= sig.klass %>"><%= sig.name %></a></li>
148+
<% }) %>
149149
</ul>
150150
</div>
151151
<% } %> <!-- if we have version history -->
@@ -168,7 +168,7 @@ <h3>versions</h3>
168168
<div class="also">
169169
Also in <a href="<%= alsoGroup %>"><%= groupName %></a> group: <br/>
170170
<% _.each(_.initial(alsoLinks), function(link) { %>
171-
<a href="<%= link.url %>"><%= link.name %></a>,
171+
<a href="<%= link.url %>"><%= link.name %></a>,
172172
<% }) %>
173173
<% var link = _.last(alsoLinks) %>
174174
<a href="<%= link.url %>"><%= link.name %></a>.
@@ -182,11 +182,11 @@ <h1>Public API Functions</h1>
182182
<% _.each(groups, function(group) { %>
183183
<h2 class="funcGroup"><%= group.name %></h2>
184184
<p class="functionList">
185-
<% _.each(_.initial(group.funs), function(fun) { %>
186-
<a href="<%= fun.url %>" class="<%= fun.klass %>"><%= fun.name %></a>
187-
<% }) %> <!-- loop through all but the last function -->
188-
<% var fun = _.last(group.funs) %>
189-
<a href="<%= fun.url %>" class="<%= fun.klass %>"><%= fun.name %></a>
185+
<% _.each(_.initial(group.funs), function(fun) { %>
186+
<a href="<%= fun.url %>" class="<%= fun.klass %>"><%= fun.name %></a>
187+
<% }) %> <!-- loop through all but the last function -->
188+
<% var fun = _.last(group.funs) %>
189+
<a href="<%= fun.url %>" class="<%= fun.klass %>"><%= fun.name %></a>
190190
</p>
191191
<% }) %> <!-- loop through the groups -->
192192
</script>
@@ -211,8 +211,8 @@ <h3>Argument in</h3>
211211
<% } %> <!-- if we have 'needs' -->
212212

213213
<div class="fileLink">
214-
Defined in:
215-
<a href="<%= fileLink.url %>"><%= fileLink.name %></a>
214+
Defined in:
215+
<a href="<%= fileLink.url %>"><%= fileLink.name %></a>
216216
</div>
217217
</script>
218218

@@ -229,19 +229,20 @@ <h1 class="funcTitle"><%= type.tname %><small><%= type.type %></small></h1>
229229
<% } %>
230230

231231
<table>
232-
<% _.each(type.data.fields, function(field) { %>
233-
<tr>
234-
<td><code><%= field.name %></code></td>
235-
<tr>
236-
<% if (field.comments) { %>
237-
<tr>
238-
<td class="type-comment"><%= field.comments %></td>
239-
</tr>
240-
<% } %>
241-
<% }) %>
232+
<% _.each(type.data.fields, function(field) { %>
233+
<tr>
234+
<td><code><%= field.name %></code></td>
235+
</tr>
236+
<% if (field.comments) { %>
237+
<tr>
238+
<td class="type-comment"><%= field.comments %></td>
239+
</tr>
240+
<% } %>
241+
<% }) %>
242242
</table>
243243
<%= uses %>
244244
</script>
245+
245246
<!-- listing for a struct -->
246247
<script type="text/template" id="struct-template">
247248
<h1 class="funcTitle"><%= type.tname %><small><%= type.type %></small></h1>
@@ -255,17 +256,17 @@ <h1 class="funcTitle"><%= type.tname %><small><%= type.type %></small></h1>
255256
<% } %>
256257

257258
<table>
258-
<% _.each(type.data.fields, function(field) { %>
259-
<tr>
260-
<td><code><%= field.type %></code></td>
261-
<td><code><%= field.name %></code></td>
262-
<tr>
263-
<% if (field.comments) { %>
264-
<tr>
265-
<td colspan="2" class="type-comment"><%= field.comments %></td>
266-
</tr>
267-
<% } %>
268-
<% }) %>
259+
<% _.each(type.data.fields, function(field) { %>
260+
<tr>
261+
<td><code><%= field.type %></code></td>
262+
<td><code><%= field.name %></code></td>
263+
<tr>
264+
<% if (field.comments) { %>
265+
<tr>
266+
<td colspan="2" class="type-comment"><%= field.comments %></td>
267+
</tr>
268+
<% } %>
269+
<% }) %>
269270
</table>
270271

271272
<%= uses %>
@@ -275,41 +276,42 @@ <h1 class="funcTitle"><%= type.tname %><small><%= type.type %></small></h1>
275276
<h1><%= gname %> functions</h1>
276277
<!-- table with all the functions -->
277278
<table class="methods">
278-
<% _.each(functions, function(fun) { %>
279-
<tr>
280-
<td valign="top" nowrap="true">
281-
<%= fun.returns %>
282-
</td>
283-
<td valign="top" class="methodName">
284-
<a href="<%= fun.url %>"><%= fun.name %></a>
285-
</td>
286-
<td>
287-
<% _.each(fun.args, function(arg) { %>
288-
<%= arg.type %> <%= arg.name %><br/>
289-
<% }) %> <!-- loop over the args of a function -->
290-
</td>
291-
</tr>
292-
<% }) %> <!-- loop over the functions -->
279+
<% _.each(functions, function(fun) { %>
280+
<tr>
281+
<td valign="top" nowrap="true">
282+
<%= fun.returns %>
283+
</td>
284+
<td valign="top" class="methodName">
285+
<a href="<%= fun.url %>"><%= fun.name %></a>
286+
</td>
287+
<td>
288+
<% _.each(fun.args, function(arg) { %>
289+
<%= arg.type %> <%= arg.name %><br/>
290+
<% }) %> <!-- loop over the args of a function -->
291+
</td>
292+
</tr>
293+
<% }) %> <!-- loop over the functions -->
293294
</table>
295+
294296
<!-- list of the functions with the descriptions -->
295297
<% _.each(functions, function(fun) { %>
296298
<h2><a href="<%= fun.url %>"><%= fun.name %></a><small>(<%= fun.argline %>)</small></h2>
297299
<div class="description">
298-
<%= fun.description %>
299-
<%= fun.comments %>
300+
<%= fun.description %>
301+
<%= fun.comments %>
300302
</div>
301303
<% }) %> <!-- loop over the functions -->
302304
</script>
303305

304306
<script type="text/template" id="search-template">
305307
<h1>Search Results</h1>
306308
<table>
307-
<% _.each(results, function(result) { %>
308-
<tr>
309-
<td><a href="<%= result.url %>"><%= result.name %></a></td>
310-
<td><%= result.match %></td>
311-
</tr>
312-
<% }) %>
309+
<% _.each(results, function(result) { %>
310+
<tr>
311+
<td><a href="<%= result.url %>"><%= result.name %></a></td>
312+
<td><%= result.match %></td>
313+
</tr>
314+
<% }) %>
313315
</table>
314316
</script>
315317

0 commit comments

Comments
 (0)