updating documentation

perezd · Feb 18, 2009 · 1491f87 · 1491f87
1 parent e1dbcd1
commit 1491f87
Show file tree

Hide file tree

Showing 24 changed files with 939 additions and 391 deletions.
diff --git a/rdoc/classes/Date.html b/rdoc/classes/Date.html
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Date</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Date</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/smart_month/extensions/date_rb.html">
+                lib/smart_month/extensions/date.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+inject the extension mixin to the base class
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+    <div id="includes">
+      <h3 class="section-bar">Included Modules</h3>
+
+      <div id="includes-list">
+        <span class="include-name"><a href="SmartMonth/Extensions/Date.html">SmartMonth::Extensions::Date</a></span>
+      </div>
+    </div>
+
+    <div id="section">
+
+
+
+
+
+
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
diff --git a/rdoc/classes/Month.html b/rdoc/classes/Month.html
@@ -165,10 +165,10 @@ <h3 class="section-bar">Public Class methods</h3>
             onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000001-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/month.rb, line 25</span>
-25:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">month</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">mon</span>, <span class="ruby-identifier">year</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">year</span>)
-26:     <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">year</span>,( <span class="ruby-identifier">month</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">month</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Month</span><span class="ruby-operator">::</span><span class="ruby-constant">NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">month</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>) ) ,<span class="ruby-value">1</span>) 
-27:   <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/month.rb, line 23</span>
+23:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">month</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">mon</span>, <span class="ruby-identifier">year</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">year</span>)
+24:     <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">year</span>,( <span class="ruby-identifier">month</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">month</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Month</span><span class="ruby-operator">::</span><span class="ruby-constant">NAMES</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">month</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">capitalize</span>) ) ,<span class="ruby-value">1</span>) 
+25:   <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

diff --git a/rdoc/classes/SmartMonth.html b/rdoc/classes/SmartMonth.html
@@ -62,6 +62,10 @@
                 <a href="../files/lib/smart_month/collection_rb.html">
                 lib/smart_month/collection.rb
                 </a>
+        <br />
+                <a href="../files/lib/smart_month/extensions/date_rb.html">
+                lib/smart_month/extensions/date.rb
+                </a>
         <br />
                 <a href="../files/lib/smart_month/magic_rb.html">
                 lib/smart_month/magic.rb
@@ -92,6 +96,13 @@
 
   <div id="contextContent">
 
+    <div id="description">
+      <p>
+This module extends the core <a href="Date.html">Date</a> class
+functionality for use throughout smart_month.
+</p>
+
+    </div>
 
 
    </div>
@@ -109,6 +120,7 @@ <h3 class="section-bar">Classes and Modules</h3>
 
       Module <a href="SmartMonth/Calculations.html" class="link">SmartMonth::Calculations</a><br />
 Module <a href="SmartMonth/Collection.html" class="link">SmartMonth::Collection</a><br />
+Module <a href="SmartMonth/Extensions.html" class="link">SmartMonth::Extensions</a><br />
 Module <a href="SmartMonth/Magic.html" class="link">SmartMonth::Magic</a><br />
 Module <a href="SmartMonth/Math.html" class="link">SmartMonth::Math</a><br />
 Module <a href="SmartMonth/Util.html" class="link">SmartMonth::Util</a><br />