Skip to content

Commit 842dfbc

Browse files
jcasimirjcasimir
committed
Basic YARD documentation
1 parent 8ff68f3 commit 842dfbc

25 files changed

+4023
-0
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ Gemfile.lock
55
pkg/*
66
coverage.data
77
coverage/*
8+
.yardoc

‎.yardopts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
yardoc 'lib/draper/**/*.rb' -m markdown

‎Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ gem 'guard-rspec'
99
gem 'launchy'
1010
gem 'rcov', :platforms => [:mri_18]
1111
gem 'cover_me', '>= 1.0.0.rc6', :platforms => [:mri_19]
12+
gem 'yard'
1213

1314
gemspec

‎doc/ApplicationDecorator.html

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<title>
7+
Class: ApplicationDecorator
8+
9+
&mdash; Documentation by YARD 0.7.2
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16+
17+
<script type="text/javascript" charset="utf-8">
18+
relpath = '';
19+
if (relpath != '') relpath += '/';
20+
</script>
21+
22+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
23+
24+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
25+
26+
27+
</head>
28+
<body>
29+
<script type="text/javascript" charset="utf-8">
30+
if (window.top.frames.main) document.body.className = 'frames';
31+
</script>
32+
33+
<div id="header">
34+
<div id="menu">
35+
36+
<a href="_index.html">Index (A)</a> &raquo;
37+
38+
39+
<span class="title">ApplicationDecorator</span>
40+
41+
42+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43+
</div>
44+
45+
<div id="search">
46+
47+
<a id="class_list_link" href="#">Class List</a>
48+
49+
<a id="method_list_link" href="#">Method List</a>
50+
51+
<a id="file_list_link" href="#">File List</a>
52+
53+
</div>
54+
<div class="clear"></div>
55+
</div>
56+
57+
<iframe id="search_frame"></iframe>
58+
59+
<div id="content"><h1>Class: ApplicationDecorator
60+
61+
62+
63+
</h1>
64+
65+
<dl class="box">
66+
67+
<dt class="r1">Inherits:</dt>
68+
<dd class="r1">
69+
<span class="inheritName"><span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></span>
70+
71+
<ul class="fullTree">
72+
<li>Object</li>
73+
74+
<li class="next"><span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></li>
75+
76+
<li class="next">ApplicationDecorator</li>
77+
78+
</ul>
79+
<a href="#" class="inheritanceTree">show all</a>
80+
81+
</dd>
82+
83+
84+
85+
86+
87+
88+
89+
90+
91+
<dt class="r2 last">Defined in:</dt>
92+
<dd class="r2 last">lib/generators/draper/decorator/templates/application_decorator.rb</dd>
93+
94+
</dl>
95+
<div class="clear"></div>
96+
97+
98+
<h2>Constant Summary</h2>
99+
100+
101+
102+
103+
104+
105+
106+
<h3 class="inherited">Constants inherited from <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></h3>
107+
<p class="inherited"><span class='object_link'><a href="Draper/Base.html#DEFAULT_DENIED-constant" title="Draper::Base::DEFAULT_DENIED (constant)">DEFAULT_DENIED</a></span>, <span class='object_link'><a href="Draper/Base.html#FORCED_PROXY-constant" title="Draper::Base::FORCED_PROXY (constant)">FORCED_PROXY</a></span></p>
108+
109+
110+
111+
112+
113+
114+
<h2>Instance Attribute Summary</h2>
115+
116+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></h3>
117+
<p class="inherited"><span class='object_link'><a href="Draper/Base.html#context-instance_method" title="Draper::Base#context (method)">context</a></span>, <span class='object_link'><a href="Draper/Base.html#model-instance_method" title="Draper::Base#model (method)">model</a></span></p>
118+
119+
120+
121+
122+
123+
124+
125+
126+
<h2>Method Summary</h2>
127+
128+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></h3>
129+
<p class="inherited"><span class='object_link'><a href="Draper/Base.html#allows-class_method" title="Draper::Base.allows (method)">allows</a></span>, <span class='object_link'><a href="Draper/Base.html#decorate-class_method" title="Draper::Base.decorate (method)">decorate</a></span>, <span class='object_link'><a href="Draper/Base.html#decorates-class_method" title="Draper::Base.decorates (method)">decorates</a></span>, <span class='object_link'><a href="Draper/Base.html#denies-class_method" title="Draper::Base.denies (method)">denies</a></span>, <span class='object_link'><a href="Draper/Base.html#find-class_method" title="Draper::Base.find (method)">find</a></span>, <span class='object_link'><a href="Draper/Base.html#helpers-instance_method" title="Draper::Base#helpers (method)">#helpers</a></span>, <span class='object_link'><a href="Draper/Base.html#initialize-instance_method" title="Draper::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Draper/Base.html#lazy_helpers-class_method" title="Draper::Base.lazy_helpers (method)">lazy_helpers</a></span>, <span class='object_link'><a href="Draper/Base.html#model_name-class_method" title="Draper::Base.model_name (method)">model_name</a></span>, <span class='object_link'><a href="Draper/Base.html#to_model-instance_method" title="Draper::Base#to_model (method)">#to_model</a></span></p>
130+
<div id="constructor_details" class="method_details_list">
131+
<h2>Constructor Details</h2>
132+
133+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Draper/Base.html#initialize-instance_method" title="Draper::Base#initialize (method)">Draper::Base</a></span></p>
134+
135+
</div>
136+
137+
138+
</div>
139+
140+
<div id="footer">
141+
Generated on Wed Aug 31 23:53:09 2011 by
142+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
143+
0.7.2 (ruby-1.8.7).
144+
</div>
145+
146+
</body>
147+
</html>

‎doc/Draper.html

+123
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6+
<title>
7+
Module: Draper
8+
9+
&mdash; Documentation by YARD 0.7.2
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16+
17+
<script type="text/javascript" charset="utf-8">
18+
relpath = '';
19+
if (relpath != '') relpath += '/';
20+
</script>
21+
22+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
23+
24+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
25+
26+
27+
</head>
28+
<body>
29+
<script type="text/javascript" charset="utf-8">
30+
if (window.top.frames.main) document.body.className = 'frames';
31+
</script>
32+
33+
<div id="header">
34+
<div id="menu">
35+
36+
<a href="_index.html">Index (D)</a> &raquo;
37+
38+
39+
<span class="title">Draper</span>
40+
41+
42+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43+
</div>
44+
45+
<div id="search">
46+
47+
<a id="class_list_link" href="#">Class List</a>
48+
49+
<a id="method_list_link" href="#">Method List</a>
50+
51+
<a id="file_list_link" href="#">File List</a>
52+
53+
</div>
54+
<div class="clear"></div>
55+
</div>
56+
57+
<iframe id="search_frame"></iframe>
58+
59+
<div id="content"><h1>Module: Draper
60+
61+
62+
63+
</h1>
64+
65+
<dl class="box">
66+
67+
68+
69+
70+
71+
72+
73+
74+
<dt class="r1 last">Defined in:</dt>
75+
<dd class="r1 last">lib/draper/base.rb<span class="defines">,<br />
76+
lib/draper/system.rb,<br /> lib/draper/version.rb,<br /> lib/draper/all_helpers.rb,<br /> lib/draper/lazy_helpers.rb</span>
77+
</dd>
78+
79+
</dl>
80+
<div class="clear"></div>
81+
82+
<h2>Defined Under Namespace</h2>
83+
<p class="children">
84+
85+
86+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Draper/AllHelpers.html" title="Draper::AllHelpers (module)">AllHelpers</a></span>, <span class='object_link'><a href="Draper/LazyHelpers.html" title="Draper::LazyHelpers (module)">LazyHelpers</a></span>, <span class='object_link'><a href="Draper/ModelSupport.html" title="Draper::ModelSupport (module)">ModelSupport</a></span>
87+
88+
89+
90+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Base</a></span>, <span class='object_link'><a href="Draper/System.html" title="Draper::System (class)">System</a></span>
91+
92+
93+
</p>
94+
95+
<h2>Constant Summary</h2>
96+
97+
<dl class="constants">
98+
99+
<dt id="VERSION-constant" class="">VERSION =
100+
101+
</dt>
102+
<dd><pre class="code"><span class='string val'>&quot;0.7.3&quot;</span>
103+
</pre></dd>
104+
105+
</dl>
106+
107+
108+
109+
110+
111+
112+
113+
114+
</div>
115+
116+
<div id="footer">
117+
Generated on Thu Sep 1 01:13:36 2011 by
118+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119+
0.7.2 (ruby-1.8.7).
120+
</div>
121+
122+
</body>
123+
</html>

0 commit comments

Comments
 (0)