Skip to content

Commit 82cd468

Browse files
gastonmorixegastonmorixe
committed
docs yard
1 parent 49e390b commit 82cd468

24 files changed

+4612
-1
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ pkg/*
1212
spec/dummy/tmp/*
1313
spec/dummy/log/*.log
1414
.idea
15+
.yardoc

‎.yardopts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
--debug
55
--markup=markdown
66
--readme=README.md
7+
--output-dir=./docs/yard
78
--title='Rails Fields - Ruby API Documentation'
8-
'lib/**/*.rb' - '*.md'
9+
'lib/**/*.rb' - '*.md'.yardoc/

‎docs/yard/RailsFields.html‎

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,303 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Module: RailsFields
8+
9+
&mdash; Rails Fields - Ruby API Documentation
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "RailsFields";
19+
relpath = '';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="_index.html">Index (R)</a> &raquo;
40+
41+
42+
<span class="title">RailsFields</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Module: RailsFields
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
<dl>
80+
<dt>Defined in:</dt>
81+
<dd>lib/rails_fields.rb<span class="defines">,<br />
82+
lib/rails_fields/version.rb,<br /> lib/rails_fields/class_methods.rb,<br /> lib/rails_fields/utils/helpers.rb,<br /> lib/rails_fields/utils/logging.rb,<br /> lib/rails_fields/utils/mappings.rb,<br /> lib/rails_fields/instance_methods.rb,<br /> lib/rails_fields/errors/rails_fields_error.rb,<br /> lib/rails_fields/errors/rails_fields_mismatch_error.rb,<br /> lib/rails_fields/errors/rails_fields_unknown_type_error.rb</span>
83+
</dd>
84+
</dl>
85+
86+
</div>
87+
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
<p>Provides enforcement of declared field for ActiveRecord models.</p>
91+
92+
93+
</div>
94+
</div>
95+
<div class="tags">
96+
97+
98+
</div><h2>Defined Under Namespace</h2>
99+
<p class="children">
100+
101+
102+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="RailsFields/ClassMethods.html" title="RailsFields::ClassMethods (module)">ClassMethods</a></span>, <span class='object_link'><a href="RailsFields/Errors.html" title="RailsFields::Errors (module)">Errors</a></span>, <span class='object_link'><a href="RailsFields/InstanceMethods.html" title="RailsFields::InstanceMethods (module)">InstanceMethods</a></span>, <span class='object_link'><a href="RailsFields/Utils.html" title="RailsFields::Utils (module)">Utils</a></span>
103+
104+
105+
106+
107+
</p>
108+
109+
110+
<h2>
111+
Constant Summary
112+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
113+
</h2>
114+
115+
<dl class="constants">
116+
117+
<dt id="VERSION-constant" class="">VERSION =
118+
119+
</dt>
120+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
121+
122+
</dl>
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
<h2>
133+
Class Method Summary
134+
<small><a href="#" class="summary_toggle">collapse</a></small>
135+
</h2>
136+
137+
<ul class="summary">
138+
139+
<li class="public ">
140+
<span class="summary_signature">
141+
142+
<a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) &#x21d2; Object </a>
143+
144+
145+
146+
</span>
147+
148+
149+
150+
151+
152+
153+
154+
155+
156+
<span class="summary_desc"><div class='inline'>
157+
</div></span>
158+
159+
</li>
160+
161+
162+
<li class="public ">
163+
<span class="summary_signature">
164+
165+
<a href="#processed_classes-class_method" title="processed_classes (class method)">.<strong>processed_classes</strong> &#x21d2; Object </a>
166+
167+
168+
169+
</span>
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
<span class="summary_desc"><div class='inline'>
180+
</div></span>
181+
182+
</li>
183+
184+
185+
</ul>
186+
187+
188+
189+
190+
<div id="class_method_details" class="method_details_list">
191+
<h2>Class Method Details</h2>
192+
193+
194+
<div class="method_details first">
195+
<h3 class="signature first" id="included-class_method">
196+
197+
.<strong>included</strong>(base) &#x21d2; <tt>Object</tt>
198+
199+
200+
201+
202+
203+
</h3><div class="docstring">
204+
<div class="discussion">
205+
206+
207+
208+
</div>
209+
</div>
210+
<div class="tags">
211+
<p class="tag_title">Parameters:</p>
212+
<ul class="param">
213+
214+
<li>
215+
216+
<span class='name'>base</span>
217+
218+
219+
<span class='type'>(<tt>ActiveRecord::Base</tt>)</span>
220+
221+
222+
223+
&mdash;
224+
<div class='inline'><p>the model to include the module in</p>
225+
</div>
226+
227+
</li>
228+
229+
</ul>
230+
231+
232+
</div><table class="source_code">
233+
<tr>
234+
<td>
235+
<pre class="lines">
236+
237+
238+
19
239+
20
240+
21
241+
22
242+
23
243+
24
244+
25</pre>
245+
</td>
246+
<td>
247+
<pre class="code"><span class="info file"># File 'lib/rails_fields.rb', line 19</span>
248+
249+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
250+
<span class='comment'># base.extend(ClassMethods)
251+
</span> <span class='comment'># todo: raise if class methods not found
252+
</span> <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_after_initialize'>after_initialize</span> <span class='kw'>do</span>
253+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_enforce_declared_fields'>enforce_declared_fields</span>
254+
<span class='kw'>end</span>
255+
<span class='kw'>end</span></pre>
256+
</td>
257+
</tr>
258+
</table>
259+
</div>
260+
261+
<div class="method_details ">
262+
<h3 class="signature " id="processed_classes-class_method">
263+
264+
.<strong>processed_classes</strong> &#x21d2; <tt>Object</tt>
265+
266+
267+
268+
269+
270+
</h3><table class="source_code">
271+
<tr>
272+
<td>
273+
<pre class="lines">
274+
275+
276+
14
277+
15
278+
16</pre>
279+
</td>
280+
<td>
281+
<pre class="code"><span class="info file"># File 'lib/rails_fields.rb', line 14</span>
282+
283+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_processed_classes'>processed_classes</span>
284+
<span class='ivar'>@processed_classes</span>
285+
<span class='kw'>end</span></pre>
286+
</td>
287+
</tr>
288+
</table>
289+
</div>
290+
291+
</div>
292+
293+
</div>
294+
295+
<div id="footer">
296+
Generated on Sun Aug 27 17:34:57 2023 by
297+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
298+
0.9.34 (ruby-3.2.2).
299+
</div>
300+
301+
</div>
302+
</body>
303+
</html>

0 commit comments

Comments
 (0)