Basic YARD documentation

theozaurus · Sep 1, 2011 · 842dfbc · 842dfbc
1 parent 8ff68f3
commit 842dfbc
Show file tree

Hide file tree

Showing 25 changed files with 4,023 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ Gemfile.lock
 pkg/*
 coverage.data
 coverage/*
+.yardoc
diff --git a/.yardopts b/.yardopts
@@ -0,0 +1 @@
+yardoc 'lib/draper/**/*.rb' -m markdown
diff --git a/Gemfile b/Gemfile
@@ -9,5 +9,6 @@ gem 'guard-rspec'
 gem 'launchy'  
 gem 'rcov', :platforms => [:mri_18]
 gem 'cover_me', '>= 1.0.0.rc6', :platforms => [:mri_19]  
+gem 'yard'
 
 gemspec
diff --git a/doc/ApplicationDecorator.html b/doc/ApplicationDecorator.html
@@ -0,0 +1,147 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: ApplicationDecorator
+
+    &mdash; Documentation by YARD 0.7.2
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <div id="header">
+      <div id="menu">
+
+    <a href="_index.html">Index (A)</a> &raquo; 
+
+
+    <span class="title">ApplicationDecorator</span>
+
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+
+    <a id="class_list_link" href="#">Class List</a>
+
+    <a id="method_list_link" href="#">Method List</a>
+
+    <a id="file_list_link" href="#">File List</a>
+
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: ApplicationDecorator
+
+
+
+</h1>
+
+<dl class="box">
+
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></span>
+
+        <ul class="fullTree">
+          <li>Object</li>
+
+            <li class="next"><span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></li>
+
+            <li class="next">ApplicationDecorator</li>
+
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+
+      </dd>
+
+
+
+
+
+
+
+
+
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/generators/draper/decorator/templates/application_decorator.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+
+  <h2>Constant Summary</h2>
+
+
+
+
+
+
+
+  <h3 class="inherited">Constants inherited from <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Draper/Base.html#DEFAULT_DENIED-constant" title="Draper::Base::DEFAULT_DENIED (constant)">DEFAULT_DENIED</a></span>, <span class='object_link'><a href="Draper/Base.html#FORCED_PROXY-constant" title="Draper::Base::FORCED_PROXY (constant)">FORCED_PROXY</a></span></p>
+
+
+
+
+
+
+  <h2>Instance Attribute Summary</h2>
+
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Draper/Base.html#context-instance_method" title="Draper::Base#context (method)">context</a></span>, <span class='object_link'><a href="Draper/Base.html#model-instance_method" title="Draper::Base#model (method)">model</a></span></p>
+
+
+
+
+
+
+
+
+  <h2>Method Summary</h2>
+
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Draper::Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Draper/Base.html#allows-class_method" title="Draper::Base.allows (method)">allows</a></span>, <span class='object_link'><a href="Draper/Base.html#decorate-class_method" title="Draper::Base.decorate (method)">decorate</a></span>, <span class='object_link'><a href="Draper/Base.html#decorates-class_method" title="Draper::Base.decorates (method)">decorates</a></span>, <span class='object_link'><a href="Draper/Base.html#denies-class_method" title="Draper::Base.denies (method)">denies</a></span>, <span class='object_link'><a href="Draper/Base.html#find-class_method" title="Draper::Base.find (method)">find</a></span>, <span class='object_link'><a href="Draper/Base.html#helpers-instance_method" title="Draper::Base#helpers (method)">#helpers</a></span>, <span class='object_link'><a href="Draper/Base.html#initialize-instance_method" title="Draper::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Draper/Base.html#lazy_helpers-class_method" title="Draper::Base.lazy_helpers (method)">lazy_helpers</a></span>, <span class='object_link'><a href="Draper/Base.html#model_name-class_method" title="Draper::Base.model_name (method)">model_name</a></span>, <span class='object_link'><a href="Draper/Base.html#to_model-instance_method" title="Draper::Base#to_model (method)">#to_model</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Draper/Base.html#initialize-instance_method" title="Draper::Base#initialize (method)">Draper::Base</a></span></p>
+
+</div>
+
+
+</div>
+
+    <div id="footer">
+  Generated on Wed Aug 31 23:53:09 2011 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.2 (ruby-1.8.7).
+</div>
+
+  </body>
+</html>
diff --git a/doc/Draper.html b/doc/Draper.html
@@ -0,0 +1,123 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Draper
+
+    &mdash; Documentation by YARD 0.7.2
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <div id="header">
+      <div id="menu">
+
+    <a href="_index.html">Index (D)</a> &raquo; 
+
+
+    <span class="title">Draper</span>
+
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+
+    <a id="class_list_link" href="#">Class List</a>
+
+    <a id="method_list_link" href="#">Method List</a>
+
+    <a id="file_list_link" href="#">File List</a>
+
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Draper
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/draper/base.rb<span class="defines">,<br />
+  lib/draper/system.rb,<br /> lib/draper/version.rb,<br /> lib/draper/all_helpers.rb,<br /> lib/draper/lazy_helpers.rb</span>
+</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Draper/AllHelpers.html" title="Draper::AllHelpers (module)">AllHelpers</a></span>, <span class='object_link'><a href="Draper/LazyHelpers.html" title="Draper::LazyHelpers (module)">LazyHelpers</a></span>, <span class='object_link'><a href="Draper/ModelSupport.html" title="Draper::ModelSupport (module)">ModelSupport</a></span>
+
+
+
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Draper/Base.html" title="Draper::Base (class)">Base</a></span>, <span class='object_link'><a href="Draper/System.html" title="Draper::System (class)">System</a></span>
+
+
+</p>
+
+  <h2>Constant Summary</h2>
+
+    <dl class="constants">
+
+        <dt id="VERSION-constant" class="">VERSION =
+
+        </dt>
+        <dd><pre class="code"><span class='string val'>&quot;0.7.3&quot;</span>
+</pre></dd>
+
+    </dl>
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Sep  1 01:13:36 2011 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.2 (ruby-1.8.7).
+</div>
+
+  </body>
+</html>