Skip to content

Commit 9f810b1

Browse files
toshimarutoshimaru
authored
docs: Generate docs with new sdoc (#199)
1 parent d2290eb commit 9f810b1

File tree

936 files changed

+17405
-55745
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

936 files changed

+17405
-55745
lines changed

‎src/classes/AbstractController/Base.html‎

Lines changed: 60 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -149,17 +149,11 @@ <h2 id="attributes">Attributes</h2>
149149
<h2 id="class-public-methods">Class Public methods</h2>
150150

151151
<div class="method">
152-
<h3 id="method-c-abstract-21">
153-
154-
abstract!()
155-
156-
</h3>
152+
<h3 id="method-c-abstract-21"><code><b>abstract!</b>()</code></h3>
157153

158-
159-
<div class="description">
160-
<p>Define a controller as abstract. See <a href="Base.html#method-c-internal_methods"><code>internal_methods</code></a> for more details.</p>
161-
</div>
162-
154+
<div class="description">
155+
<p>Define a controller as abstract. See <a href="Base.html#method-c-internal_methods"><code>internal_methods</code></a> for more details.</p>
156+
</div>
163157

164158

165159

@@ -184,17 +178,11 @@ <h3 id="method-c-abstract-21">
184178
</div>
185179

186180
<div class="method">
187-
<h3 id="method-c-action_methods">
188-
189-
action_methods()
190-
191-
</h3>
181+
<h3 id="method-c-action_methods"><code><b>action_methods</b>()</code></h3>
192182

193-
194-
<div class="description">
195-
<p>A <code>Set</code> of method names that should be considered actions. This includes all public instance methods on a controller, less any internal methods (see <a href="Base.html#method-c-internal_methods"><code>internal_methods</code></a>), adding back in any methods that are internal, but still exist on the class itself.</p>
196-
</div>
197-
183+
<div class="description">
184+
<p>A <code>Set</code> of method names that should be considered actions. This includes all public instance methods on a controller, less any internal methods (see <a href="Base.html#method-c-internal_methods"><code>internal_methods</code></a>), adding back in any methods that are internal, but still exist on the class itself.</p>
185+
</div>
198186

199187

200188

@@ -228,17 +216,11 @@ <h3 id="method-c-action_methods">
228216
</div>
229217

230218
<div class="method">
231-
<h3 id="method-c-clear_action_methods-21">
232-
233-
clear_action_methods!()
234-
235-
</h3>
219+
<h3 id="method-c-clear_action_methods-21"><code><b>clear_action_methods!</b>()</code></h3>
236220

237-
238-
<div class="description">
239-
<p><a href="Base.html#method-c-action_methods"><code>action_methods</code></a> are cached and there is sometimes a need to refresh them. <a href="Base.html#method-c-clear_action_methods-21"><code>::clear_action_methods!</code></a> allows you to do that, so next time you run <a href="Base.html#method-c-action_methods"><code>action_methods</code></a>, they will be recalculated.</p>
240-
</div>
241-
221+
<div class="description">
222+
<p><a href="Base.html#method-c-action_methods"><code>action_methods</code></a> are cached and there is sometimes a need to refresh them. <a href="Base.html#method-c-clear_action_methods-21"><code>::clear_action_methods!</code></a> allows you to do that, so next time you run <a href="Base.html#method-c-action_methods"><code>action_methods</code></a>, they will be recalculated.</p>
223+
</div>
242224

243225

244226

@@ -263,24 +245,18 @@ <h3 id="method-c-clear_action_methods-21">
263245
</div>
264246

265247
<div class="method">
266-
<h3 id="method-c-controller_path">
267-
268-
controller_path()
269-
270-
</h3>
248+
<h3 id="method-c-controller_path"><code><b>controller_path</b>()</code></h3>
271249

272-
273-
<div class="description">
274-
<p>Returns the full controller name, underscored, without the ending Controller.</p>
250+
<div class="description">
251+
<p>Returns the full controller name, underscored, without the ending Controller.</p>
275252

276253
<pre><code>class MyApp::MyPostsController &lt; AbstractController::Base
277254

278255
end
279256

280257
MyApp::MyPostsController.controller_path # =&gt; &quot;my_app/my_posts&quot;
281258
</code></pre>
282-
</div>
283-
259+
</div>
284260

285261

286262

@@ -305,17 +281,11 @@ <h3 id="method-c-controller_path">
305281
</div>
306282

307283
<div class="method">
308-
<h3 id="method-c-internal_methods">
309-
310-
internal_methods()
311-
312-
</h3>
284+
<h3 id="method-c-internal_methods"><code><b>internal_methods</b>()</code></h3>
313285

314-
315-
<div class="description">
316-
<p>A list of all internal methods for a controller. This finds the first abstract superclass of a controller, and gets a list of all public instance methods on that abstract class. Public instance methods of a controller would normally be considered action methods, so methods declared on abstract classes are being removed. (<a href="../ActionController/Metal.html"><code>ActionController::Metal</code></a> and <a href="../ActionController/Base.html"><code>ActionController::Base</code></a> are defined as abstract)</p>
317-
</div>
318-
286+
<div class="description">
287+
<p>A list of all internal methods for a controller. This finds the first abstract superclass of a controller, and gets a list of all public instance methods on that abstract class. Public instance methods of a controller would normally be considered action methods, so methods declared on abstract classes are being removed. (<a href="../ActionController/Metal.html"><code>ActionController::Metal</code></a> and <a href="../ActionController/Base.html"><code>ActionController::Base</code></a> are defined as abstract)</p>
288+
</div>
319289

320290

321291

@@ -348,17 +318,11 @@ <h3 id="method-c-internal_methods">
348318
</div>
349319

350320
<div class="method">
351-
<h3 id="method-c-method_added">
352-
353-
method_added(name)
354-
355-
</h3>
321+
<h3 id="method-c-method_added"><code><b>method_added</b>(name)</code></h3>
356322

357-
358-
<div class="description">
359-
<p>Refresh the cached <a href="Base.html#method-c-action_methods"><code>action_methods</code></a> when a new action_method is added.</p>
360-
</div>
361-
323+
<div class="description">
324+
<p>Refresh the cached <a href="Base.html#method-c-action_methods"><code>action_methods</code></a> when a new action_method is added.</p>
325+
</div>
362326

363327

364328

@@ -384,17 +348,11 @@ <h3 id="method-c-method_added">
384348
</div>
385349

386350
<div class="method">
387-
<h3 id="method-c-supports_path-3F">
388-
389-
supports_path?()
390-
391-
</h3>
351+
<h3 id="method-c-supports_path-3F"><code><b>supports_path?</b>()</code></h3>
392352

393-
394-
<div class="description">
395-
<p>Returns true if the given controller is capable of rendering a path. A subclass of <a href="Base.html"><code>AbstractController::Base</code></a> may return false. An Email controller for example does not support paths, only full URLs.</p>
396-
</div>
397-
353+
<div class="description">
354+
<p>Returns true if the given controller is capable of rendering a path. A subclass of <a href="Base.html"><code>AbstractController::Base</code></a> may return false. An Email controller for example does not support paths, only full URLs.</p>
355+
</div>
398356

399357

400358

@@ -423,17 +381,11 @@ <h3 id="method-c-supports_path-3F">
423381
<h2 id="instance-public-methods">Instance Public methods</h2>
424382

425383
<div class="method">
426-
<h3 id="method-i-action_methods">
427-
428-
action_methods()
429-
430-
</h3>
384+
<h3 id="method-i-action_methods"><code><b>action_methods</b>()</code></h3>
431385

432-
433-
<div class="description">
434-
<p>Delegates to the class’s <a href="Base.html#method-c-action_methods"><code>::action_methods</code></a>.</p>
435-
</div>
436-
386+
<div class="description">
387+
<p>Delegates to the class’s <a href="Base.html#method-c-action_methods"><code>::action_methods</code></a>.</p>
388+
</div>
437389

438390

439391

@@ -458,17 +410,11 @@ <h3 id="method-i-action_methods">
458410
</div>
459411

460412
<div class="method">
461-
<h3 id="method-i-action_name">
462-
463-
action_name
464-
465-
</h3>
413+
<h3 id="method-i-action_name"><code><b>action_name</b></code></h3>
466414

467-
468-
<div class="description">
469-
<p>Returns the name of the action this controller is processing.</p>
470-
</div>
471-
415+
<div class="description">
416+
<p>Returns the name of the action this controller is processing.</p>
417+
</div>
472418

473419

474420

@@ -492,24 +438,18 @@ <h3 id="method-i-action_name">
492438
</div>
493439

494440
<div class="method">
495-
<h3 id="method-i-available_action-3F">
496-
497-
available_action?(action_name)
498-
499-
</h3>
441+
<h3 id="method-i-available_action-3F"><code><b>available_action?</b>(action_name)</code></h3>
500442

501-
502-
<div class="description">
503-
<p>Returns true if a method for the action is available and can be dispatched, false otherwise.</p>
443+
<div class="description">
444+
<p>Returns true if a method for the action is available and can be dispatched, false otherwise.</p>
504445

505446
<p>Notice that <code>action_methods.include?(&quot;foo&quot;)</code> may return false and <code>available_action?(&quot;foo&quot;)</code> returns true because this method considers actions that are also available through other means, for example, implicit render ones.</p>
506447

507448
<h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>
508449
<ul><li>
509450
<p><a href="Base.html#method-i-action_name"><code>action_name</code></a> - The name of an action to be tested</p>
510451
</li></ul>
511-
</div>
512-
452+
</div>
513453

514454

515455

@@ -534,17 +474,11 @@ <h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>
534474
</div>
535475

536476
<div class="method">
537-
<h3 id="method-i-controller_path">
538-
539-
controller_path()
540-
541-
</h3>
477+
<h3 id="method-i-controller_path"><code><b>controller_path</b>()</code></h3>
542478

543-
544-
<div class="description">
545-
<p>Delegates to the class’s <a href="Base.html#method-c-controller_path"><code>::controller_path</code></a>.</p>
546-
</div>
547-
479+
<div class="description">
480+
<p>Delegates to the class’s <a href="Base.html#method-c-controller_path"><code>::controller_path</code></a>.</p>
481+
</div>
548482

549483

550484

@@ -569,17 +503,11 @@ <h3 id="method-i-controller_path">
569503
</div>
570504

571505
<div class="method">
572-
<h3 id="method-i-formats">
573-
574-
formats
575-
576-
</h3>
506+
<h3 id="method-i-formats"><code><b>formats</b></code></h3>
577507

578-
579-
<div class="description">
580-
<p>Returns the formats that can be processed by the controller.</p>
581-
</div>
582-
508+
<div class="description">
509+
<p>Returns the formats that can be processed by the controller.</p>
510+
</div>
583511

584512

585513

@@ -603,17 +531,11 @@ <h3 id="method-i-formats">
603531
</div>
604532

605533
<div class="method">
606-
<h3 id="method-i-performed-3F">
607-
608-
performed?()
609-
610-
</h3>
534+
<h3 id="method-i-performed-3F"><code><b>performed?</b>()</code></h3>
611535

612-
613-
<div class="description">
614-
<p>Tests if a response body is set. Used to determine if the <code>process_action</code> callback needs to be terminated in <a href="Callbacks.html"><code>AbstractController::Callbacks</code></a>.</p>
615-
</div>
616-
536+
<div class="description">
537+
<p>Tests if a response body is set. Used to determine if the <code>process_action</code> callback needs to be terminated in <a href="Callbacks.html"><code>AbstractController::Callbacks</code></a>.</p>
538+
</div>
617539

618540

619541

@@ -638,19 +560,13 @@ <h3 id="method-i-performed-3F">
638560
</div>
639561

640562
<div class="method">
641-
<h3 id="method-i-process">
642-
643-
process(action, ...)
644-
645-
</h3>
563+
<h3 id="method-i-process"><code><b>process</b>(action, ...)</code></h3>
646564

647-
648-
<div class="description">
649-
<p>Calls the action going through the entire Action Dispatch stack.</p>
565+
<div class="description">
566+
<p>Calls the action going through the entire Action Dispatch stack.</p>
650567

651568
<p>The actual method that is called is determined by calling method_for_action. If no method can handle the action, then an <a href="ActionNotFound.html"><code>AbstractController::ActionNotFound</code></a> error is raised.</p>
652-
</div>
653-
569+
</div>
654570

655571

656572

@@ -683,17 +599,11 @@ <h3 id="method-i-process">
683599
</div>
684600

685601
<div class="method">
686-
<h3 id="method-i-response_body">
687-
688-
response_body
689-
690-
</h3>
602+
<h3 id="method-i-response_body"><code><b>response_body</b></code></h3>
691603

692-
693-
<div class="description">
694-
<p>Returns the body of the HTTP response sent by the controller.</p>
695-
</div>
696-
604+
<div class="description">
605+
<p>Returns the body of the HTTP response sent by the controller.</p>
606+
</div>
697607

698608

699609

‎src/classes/AbstractController/Caching.html‎

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,9 @@ <h2 id="included-modules">Included Modules</h2>
103103
<h2 id="instance-public-methods">Instance Public methods</h2>
104104

105105
<div class="method">
106-
<h3 id="method-i-view_cache_dependencies">
107-
108-
view_cache_dependencies()
109-
110-
</h3>
106+
<h3 id="method-i-view_cache_dependencies"><code><b>view_cache_dependencies</b>()</code></h3>
111107

112108

113-
<div class="description">
114-
115-
</div>
116-
117109

118110

119111

@@ -141,17 +133,11 @@ <h3 id="method-i-view_cache_dependencies">
141133
<h2 id="instance-private-methods">Instance Private methods</h2>
142134

143135
<div class="method">
144-
<h3 id="method-i-cache">
145-
146-
cache(key, options = {}, &amp;block)
147-
148-
</h3>
136+
<h3 id="method-i-cache"><code><b>cache</b>(key, options = {}, &amp;block)</code></h3>
149137

150-
151-
<div class="description">
152-
<p>Convenience accessor.</p>
153-
</div>
154-
138+
<div class="description">
139+
<p>Convenience accessor.</p>
140+
</div>
155141

156142

157143

0 commit comments

Comments
 (0)