doc/Trackerific/Event.html in trackerific-0.3.1 vs doc/Trackerific/Event.html in trackerific-0.3.2

- old
+ new

@@ -117,11 +117,11 @@ <ul class="summary"> <li class="public "> <span class="summary_signature"> - <a href="#date-instance_method" title="#date (instance method)">- (Time) <strong>date</strong> </a> + <a href="#date-instance_method" title="#date (instance method)">- (DateTime) <strong>date</strong> </a> </span> @@ -131,11 +131,11 @@ <span class="summary_desc"><div class='inline'><p> -The date / time of the event. +The date and time of the event. </p> </div></span> </li> @@ -177,11 +177,11 @@ - + <span class="private note title">Private</span> <span class="summary_desc"><div class='inline'><p> Provides a new instance of Event. </p> @@ -251,11 +251,15 @@ </p><div class="docstring"> <div class="discussion"> - <p> + <p class="note private"> + <strong>This method is part of a private API.</strong> + You should avoid using this method if possible, as it may be removed or be changed in the future. +</p> +<p> Provides a new instance of Event </p> </div> @@ -264,54 +268,54 @@ <h3>Parameters:</h3> <ul class="param"> <li> - <span class='name'>the</span> + <span class='name'>date</span> <span class='type'>(<tt>Time</tt>)</span> &mdash; <div class='inline'><p> -date / time of the event +the date / time of the event </p> </div> </li> <li> - <span class='name'>the</span> + <span class='name'>description</span> <span class='type'>(<tt>String</tt>)</span> &mdash; <div class='inline'><p> -event&#8217;s description +the event&#8217;s description </p> </div> </li> <li> - <span class='name'>where</span> + <span class='name'>location</span> <span class='type'>(<tt>String</tt>)</span> &mdash; <div class='inline'><p> -the event took place +where the event took place </p> </div> </li> @@ -321,18 +325,18 @@ <tr> <td> <pre class="lines"> -8 9 10 11 -12</pre> +12 +13</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 8</span> + <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 9</span> <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id date'>date</span><span class='comma'>,</span> <span class='id description'>description</span><span class='comma'>,</span> <span class='id location'>location</span><span class='rparen'>)</span> <span class='ivar'>@date</span> <span class='op'>=</span> <span class='id date'>date</span> <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id description'>description</span> <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id location'>location</span> @@ -350,56 +354,61 @@ <div class="method_details first"> <p class="signature first" id="date-instance_method"> - - (<tt>Time</tt>) <strong>date</strong> + - (<tt>DateTime</tt>) <strong>date</strong> </p><div class="docstring"> <div class="discussion"> <p> -The date / time of the event +The date and time of the event </p> </div> </div> <div class="tags"> - <h3>Returns:</h3> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Get the date of an event +</p> +</div></h4> + <pre class="example code"><span class='id date'>date</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id date'>date</span></pre> + + </div> +<h3>Returns:</h3> <ul class="return"> <li> - <span class='type'>(<tt>Time</tt>)</span> + <span class='type'>(<tt>DateTime</tt>)</span> - &mdash; - <div class='inline'><p> -the date / time of the event -</p> -</div> - </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -15 -16 -17</pre> +20 +21 +22</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 15</span> + <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 20</span> <span class='kw'>def</span> <span class='id date'>date</span> <span class='ivar'>@date</span> <span class='kw'>end</span></pre> </td> @@ -415,49 +424,54 @@ </p><div class="docstring"> <div class="discussion"> <p> -The event&#8217;s description. +The event&#8217;s description </p> </div> </div> <div class="tags"> - <h3>Returns:</h3> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Get the description of an event +</p> +</div></h4> + <pre class="example code"><span class='id description'>description</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id description'>description</span></pre> + + </div> +<h3>Returns:</h3> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> - &mdash; - <div class='inline'><p> -the event&#8217;s description. -</p> -</div> - </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -20 -21 -22</pre> +29 +30 +31</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 20</span> + <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 29</span> <span class='kw'>def</span> <span class='id description'>description</span> <span class='ivar'>@description</span> <span class='kw'>end</span></pre> </td> @@ -480,42 +494,47 @@ </div> </div> <div class="tags"> - <h3>Returns:</h3> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Get the location of an event +</p> +</div></h4> + <pre class="example code"><span class='id location'>location</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id location'>location</span></pre> + + </div> +<h3>Returns:</h3> <ul class="return"> <li> <span class='type'>(<tt>String</tt>)</span> - &mdash; - <div class='inline'><p> -where the event took place (usually in City State Zip format) -</p> -</div> - </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -26 -27 -28</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 26</span> + <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 38</span> <span class='kw'>def</span> <span class='id location'>location</span> <span class='ivar'>@location</span> <span class='kw'>end</span></pre> </td> @@ -538,11 +557,30 @@ </div> </div> <div class="tags"> - <h3>Returns:</h3> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Get a human-readable string from an event +</p> +</div></h4> + <pre class="example code"><span class='id event'>event</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id event'>event</span><span class='period'>.</span><span class='id to_s'>to_s</span></pre> + + <h4><div class='inline'><p> +A bulleted list of events in haml +</p> +</div></h4> + <pre class="example code">%ul + - details.events.each do |event| + %li= event</pre> + + </div> +<h3>Returns:</h3> <ul class="return"> <li> @@ -564,19 +602,19 @@ <tr> <td> <pre class="lines"> -31 -32 -33 -34 -35 -36</pre> +51 +52 +53 +54 +55 +56</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 31</span> + <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 51</span> <span class='kw'>def</span> <span class='id to_s'>to_s</span> <span class='id dte'>dte</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id date'>date</span><span class='period'>.</span><span class='id strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%b %d %I:%M %P</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='id des'>des</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id description'>description</span> <span class='id loc'>loc</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id location'>location</span> @@ -590,10 +628,10 @@ </div> </div> <div id="footer"> - Generated on Mon Jun 13 14:22:52 2011 by + Generated on Mon Jun 13 16:20:06 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.1 (ruby-1.9.2). </div> </body> \ No newline at end of file