Permalink
Browse files

update rdoc

  • Loading branch information...
smtlaissezfaire committed Aug 11, 2010
1 parent aaca0cc commit c57f55c259d3ffca41cd96ec98b64ea31fbb6c30
View
@@ -53,17 +53,9 @@ <h1 class='name'>
<h2>Methods</h2>
<h3>public class</h3>
<ol>
- <li><a href="#M000001">included</a></li>
+ <li><a href="#M000001">append_features</a></li>
</ol>
</div>
- <div id='context'>
- <div id='includes'>
- <h2>Included modules</h2>
- <ol>
- <li><a href="Slugify/InstanceMethods.html">InstanceMethods</a></li>
- </ol>
- </div>
- </div>
<div id='section'>
<div id='class-list'>
<h2>Classes and Modules</h2>
@@ -89,14 +81,14 @@ <h2>Public class methods</h2>
<div class='method public-class' id='method-M000001'>
<a name='M000001'></a>
<div class='synopsis'>
- <span class='name'>included</span>
+ <span class='name'>append_features</span>
<span class='arguments'>(other)</span>
</div>
<div class='source'>
<a class='source-toggle' href='#' onclick="toggleCode('M000001-source'); return false">
[show source]
</a>
- <pre id='M000001-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 7</span>&#x000A; 7: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">other</span>)&#x000A; 8: <span class="ruby-identifier">other</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">ClassMethods</span>&#x000A; 9: <span class="ruby-identifier">other</span>.<span class="ruby-identifier">class_eval</span> <span class="ruby-keyword kw">do</span>&#x000A;10: <span class="ruby-identifier">include</span> <span class="ruby-constant">InstanceMethods</span>&#x000A;11: <span class="ruby-keyword kw">end</span>&#x000A;12: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000001-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 7</span>&#x000A;7: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">append_features</span>(<span class="ruby-identifier">other</span>)&#x000A;8: <span class="ruby-identifier">other</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">ClassMethods</span>&#x000A;9: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
@@ -45,6 +45,14 @@ <h3>public instance</h3>
<li><a href="#M000002">slugify</a></li>
</ol>
</div>
+ <div id='context'>
+ <div id='includes'>
+ <h2>Included modules</h2>
+ <ol>
+ <li><a href="InstanceMethods.html">InstanceMethods</a></li>
+ </ol>
+ </div>
+ </div>
<div id='section'>
<div id='methods'>
<h2>Public instance methods</h2>
@@ -58,7 +66,7 @@ <h2>Public instance methods</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000002-source'); return false">
[show source]
</a>
- <pre id='M000002-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 15</span>&#x000A;15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">slugify</span>(<span class="ruby-identifier">source_slug_column</span>, <span class="ruby-identifier">options_given</span>={})&#x000A;16: <span class="ruby-identifier">before_save</span> <span class="ruby-identifier">:generate_slug</span>&#x000A;17: &#x000A;18: <span class="ruby-identifier">options_given</span>.<span class="ruby-identifier">symbolize_keys!</span>&#x000A;19: &#x000A;20: <span class="ruby-identifier">options_given</span>.<span class="ruby-identifier">assert_valid_keys</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">default_slug_options</span>.<span class="ruby-identifier">keys</span>)&#x000A;21: &#x000A;22: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">default_slug_options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options_given</span>)&#x000A;23: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>] = [<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>]] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:[]</span>)&#x000A;24: &#x000A;25: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:source_slug_column</span>&#x000A;26: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:slug_column</span>&#x000A;27: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:slug_scope</span>&#x000A;28: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:slugify_when</span>&#x000A;29: &#x000A;30: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">source_slug_column</span> = <span class="ruby-identifier">source_slug_column</span>&#x000A;31: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slug_column</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:slug_column</span>]&#x000A;32: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slug_scope</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>]&#x000A;33: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slugify_when</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:when</span>]&#x000A;34: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000002-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 12</span>&#x000A;12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">slugify</span>(<span class="ruby-identifier">source_slug_column</span>, <span class="ruby-identifier">options_given</span>={})&#x000A;13: <span class="ruby-identifier">before_save</span> <span class="ruby-identifier">:generate_slug</span>&#x000A;14: &#x000A;15: <span class="ruby-identifier">options_given</span>.<span class="ruby-identifier">symbolize_keys!</span>&#x000A;16: &#x000A;17: <span class="ruby-identifier">options_given</span>.<span class="ruby-identifier">assert_valid_keys</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">default_slug_options</span>.<span class="ruby-identifier">keys</span>)&#x000A;18: &#x000A;19: <span class="ruby-identifier">options</span> = <span class="ruby-identifier">default_slug_options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options_given</span>)&#x000A;20: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>] = [<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>]] <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:[]</span>)&#x000A;21: &#x000A;22: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:source_slug_column</span>&#x000A;23: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:slug_column</span>&#x000A;24: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:slug_scope</span>&#x000A;25: <span class="ruby-identifier">class_inheritable_accessor</span> <span class="ruby-identifier">:slugify_when</span>&#x000A;26: &#x000A;27: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">source_slug_column</span> = <span class="ruby-identifier">source_slug_column</span>&#x000A;28: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slug_column</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:slug_column</span>]&#x000A;29: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slug_scope</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:scope</span>]&#x000A;30: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">slugify_when</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:when</span>]&#x000A;31: &#x000A;32: <span class="ruby-identifier">include</span> <span class="ruby-constant">InstanceMethods</span>&#x000A;33: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
@@ -44,6 +44,7 @@ <h3>public instance</h3>
<ol>
<li><a href="#M000003">generate_slug</a></li>
<li><a href="#M000004">regenerate_slug</a></li>
+ <li><a href="#M000005">to_param</a></li>
</ol>
</div>
<div id='section'>
@@ -59,7 +60,7 @@ <h2>Public instance methods</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000003-source'); return false">
[show source]
</a>
- <pre id='M000003-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 48</span>&#x000A;48: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generate_slug</span>&#x000A;49: <span class="ruby-constant">Slugify</span><span class="ruby-operator">::</span><span class="ruby-constant">SlugGenerator</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-keyword kw">self</span>)&#x000A;50: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000003-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 47</span>&#x000A;47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">generate_slug</span>&#x000A;48: <span class="ruby-constant">Slugify</span><span class="ruby-operator">::</span><span class="ruby-constant">SlugGenerator</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-keyword kw">self</span>)&#x000A;49: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
<div class='method public-instance' id='method-M000004'>
@@ -72,7 +73,20 @@ <h2>Public instance methods</h2>
<a class='source-toggle' href='#' onclick="toggleCode('M000004-source'); return false">
[show source]
</a>
- <pre id='M000004-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 52</span>&#x000A;52: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">regenerate_slug</span>&#x000A;53: <span class="ruby-constant">Slugify</span><span class="ruby-operator">::</span><span class="ruby-constant">SlugGenerator</span>.<span class="ruby-identifier">regenerate</span>(<span class="ruby-keyword kw">self</span>)&#x000A;54: <span class="ruby-keyword kw">end</span></pre>
+ <pre id='M000004-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 51</span>&#x000A;51: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">regenerate_slug</span>&#x000A;52: <span class="ruby-constant">Slugify</span><span class="ruby-operator">::</span><span class="ruby-constant">SlugGenerator</span>.<span class="ruby-identifier">regenerate</span>(<span class="ruby-keyword kw">self</span>)&#x000A;53: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+ </div>
+ <div class='method public-instance' id='method-M000005'>
+ <a name='M000005'></a>
+ <div class='synopsis'>
+ <span class='name'>to_param</span>
+ <span class='arguments'>()</span>
+ </div>
+ <div class='source'>
+ <a class='source-toggle' href='#' onclick="toggleCode('M000005-source'); return false">
+ [show source]
+ </a>
+ <pre id='M000005-source'> <span class="ruby-comment cmt"># File lib/slugify.rb, line 55</span>&#x000A;55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_param</span>&#x000A;56: <span class="ruby-identifier">read_attribute</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">slug_column</span>)&#x000A;57: <span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
Oops, something went wrong.

0 comments on commit c57f55c

Please sign in to comment.