Skip to content

Commit 5c225c9

Browse files
jashkenasjashkenas
committed
updating documentation in anticipation of 0.5.0
1 parent ca11de0 commit 5c225c9

24 files changed

+3883
-2093
lines changed

‎doc/Jammit.html

Lines changed: 961 additions & 375 deletions
Large diffs are not rendered by default.

‎doc/Jammit/CommandLine.html

Lines changed: 73 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
44
<head>
5-
<meta name="Content-Type" content="text/html; charset=UTF-8" />
5+
<meta name="Content-Type" content="text/html; charset=utf-8" />
66
<title>Class: Jammit::CommandLine</title>
77
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
88
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
@@ -16,18 +16,24 @@
1616

1717
</head>
1818
<body>
19+
<script type="text/javascript" charset="utf-8">
20+
if (window.top.frames.main) document.body.className = 'frames';
21+
</script>
22+
1923
<div id="header">
2024
<div id="menu">
2125

2226
<a href="../_index.html">Index (C)</a> &raquo;
23-
<a href="../Jammit.html" title="Jammit">Jammit</a>
27+
<span class='title'><a href="../Jammit.html" title="Jammit (module)">Jammit</a></span>
2428
&raquo;
2529
<span class="title">CommandLine</span>
2630

31+
32+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
2733
</div>
2834

2935
<div id="search">
30-
<a id="class_list_link" href="#">Namespace List</a>
36+
<a id="class_list_link" href="#">Class List</a>
3137
<a id="method_list_link" href="#">Method List</a>
3238
<a id ="file_list_link" href="#">File List</a>
3339
</div>
@@ -37,7 +43,8 @@
3743

3844
<iframe id="search_frame"></iframe>
3945

40-
<div id="content"><h1>Class: Jammit::CommandLine
46+
<div id="content"><h1>Class: Jammit::CommandLine
47+
4148

4249

4350
</h1>
@@ -48,6 +55,14 @@
4855
<dd class="r1">
4956
<span class="inheritName">Object</span>
5057

58+
<ul class="fullTree">
59+
<li>Object</li>
60+
61+
<li class="next">Jammit::CommandLine</li>
62+
63+
</ul>
64+
<a href="#" class="inheritanceTree">show all</a>
65+
5166
</dd>
5267

5368

@@ -57,6 +72,7 @@
5772

5873

5974

75+
6076
<dt class="r2 last">Defined in:</dt>
6177
<dd class="r2 last">lib/jammit/command_line.rb</dd>
6278

@@ -78,8 +94,8 @@ <h2>Constant Summary</h2>
7894

7995
<dl class="constants">
8096

81-
<dt id="BANNER-constant ">BANNER =
82-
<span class="summary_desc"></span>
97+
<dt id="BANNER-constant" class="">BANNER =
98+
8399
</dt>
84100
<dd><pre class="code"><span class='string val'>&quot;\nUsage: jammit OPTIONS\n\nRun jammit inside a Rails application to compresses all JS, CSS,\nand JST according to config/assets.yml, saving the packaged\nfiles and corresponding gzipped versions.\n\nIf you're using \&quot;embed_assets\&quot;, and you wish to precompile the\nMHTML stylesheet variants, you must specify the \&quot;base-url\&quot;.\n\nOptions:\n&quot;</span>
85101
</pre></dd>
@@ -89,64 +105,90 @@ <h2>Constant Summary</h2>
89105

90106

91107

92-
<h2>Method Summary</h2>
93-
<ul class="summary">
94-
95-
<li class="public ">
96-
<span class="summary_signature"><a href="#initialize-instance_method" title="#initialize (instance method)">- (CommandLine) <strong>initialize</strong> </a>
97108

109+
<h2>
110+
Instance Method Summary
111+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
112+
</h2>
113+
114+
<ul class="summary">
115+
116+
<li class="private ">
117+
<span class="summary_signature">
118+
119+
<a href="#ensure_configuration_file-instance_method" title="#ensure_configuration_file (instance method)">- (Object) <strong>ensure_configuration_file</strong> </a>
120+
121+
122+
98123
</span>
99124

100125

126+
<span class="note title private">private</span>
127+
101128

102129

103130

104131

105-
<span class="summary_desc">The <code>Jammit::CommandLine</code> runs from the contents of <code>ARGV</code>.</span>
132+
<span class="summary_desc"><div class='inline'><p>Make sure that we have a readable configuration file.</p></div></span>
106133

107134
</li>
108135

136+
137+
<li class="public ">
138+
<span class="summary_signature">
139+
140+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (CommandLine) <strong>initialize</strong> </a>
141+
142+
109143

110-
<li class="private ">
111-
<span class="summary_signature"><a href="#ensure_configuration_file-instance_method" title="#ensure_configuration_file (instance method)">- (Object) <strong>ensure_configuration_file</strong> </a>
112-
113144
</span>
114145

115-
<span class="note title private">private</span>
146+
<span class="note title constructor">constructor</span>
147+
148+
149+
150+
116151

117152

118153

119154

120-
<span class="summary_desc">Make sure that we have a readable configuration file.</span>
155+
<span class="summary_desc"><div class='inline'><p>The <code>Jammit::CommandLine</code> runs from the contents of <code>ARGV</code>.</p></div></span>
121156

122157
</li>
123158

159+
160+
<li class="private ">
161+
<span class="summary_signature">
162+
163+
<a href="#parse_options-instance_method" title="#parse_options (instance method)">- (Object) <strong>parse_options</strong> </a>
164+
165+
124166

125-
<li class="private ">
126-
<span class="summary_signature"><a href="#parse_options-instance_method" title="#parse_options (instance method)">- (Object) <strong>parse_options</strong> </a>
127-
128167
</span>
129168

169+
130170
<span class="note title private">private</span>
131171

132172

173+
133174

134175

135-
<span class="summary_desc">Uses <code>OptionParser</code> to grab the options: <strong>&#8212;output</strong>, <strong>&#8212;config</strong>, and
136-
<strong>&#8212;base-url</strong>&#8230;</span>
176+
<span class="summary_desc"><div class='inline'><p>Uses <code>OptionParser</code> to grab the options: <strong>&#8212;output</strong>, <strong>&#8212;config</strong>, and
177+
<strong>&#8212;base-url</strong>&#8230;</p></div></span>
137178

138179
</li>
139180

140-
141-
</ul>
181+
182+
</ul>
183+
142184

143-
<div id="constructor_details">
185+
<div id="constructor_details" class="method_details_list">
144186
<h2>Constructor Details</h2>
145187

146188
<div class="method_details first">
147189
<p class="signature first" id="initialize-instance_method">
148190

149-
- (<tt><a href="" title="CommandLine">CommandLine</a></tt>) <strong>initialize</strong>
191+
- (<tt><a href="" title="Jammit::CommandLine (class)">CommandLine</a></tt>) <strong>initialize</strong>
150192

151193

152194

@@ -157,23 +199,7 @@ <h2>Constructor Details</h2>
157199
</div>
158200
</div>
159201
<div class="tags">
160-
<h3>Returns:</h3>
161-
<ul class="return">
162-
163-
<li>
164-
165-
<span class='type'>(<tt><a href="" title="CommandLine">CommandLine</a></tt>)</span>
166-
167-
168-
169-
170-
&mdash;
171-
a new instance of <ins>CommandLine</ins>
172-
173-
</li>
174202

175-
</ul>
176-
177203
</div><table class="source_code">
178204
<tr>
179205
<td>
@@ -207,8 +233,9 @@ <h3>Returns:</h3>
207233
</div>
208234

209235

210-
<div id="method_details">
211-
<h2>Method Details</h2>
236+
<div id="instance_method_details" class="method_details_list">
237+
<h2>Instance Method Details</h2>
238+
212239

213240
<div class="method_details first">
214241
<p class="signature first" id="ensure_configuration_file-instance_method">
@@ -347,9 +374,9 @@ <h2>Method Details</h2>
347374
</div>
348375

349376
<div id="footer">
350-
Generated on Sat Feb 6 10:51:33 2010 by
377+
Generated on Wed Jul 14 10:39:50 2010 by
351378
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
352-
0.4.0 (ruby-1.8.7).
379+
0.5.8 (ruby-1.8.7).
353380
</div>
354381

355382
</body>

0 commit comments

Comments
 (0)