Permalink
Browse files

adding YARD documentation

  • Loading branch information...
1 parent 9051b08 commit 97d1ea1a61b152c265f08154659a38c5973605d6 @marcinwyszynski committed Apr 25, 2012
View
@@ -0,0 +1,257 @@
+<!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: Cabalist
+
+ &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 (C)</a> &raquo;
+
+
+ <span class="title">Cabalist</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: Cabalist
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+ <dt class="r1 last">Defined in:</dt>
+ <dd class="r1 last">lib/cabalist.rb<span class="defines">,<br />
+ lib/cabalist/version.rb,<br /> lib/cabalist/railtie.rb,<br /> lib/cabalist/frontend.rb,<br /> lib/cabalist/configuration.rb,<br /> lib/cabalist/model_additions.rb</span>
+</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+ <p>
+Minimum setup machine learning (classification) library for Ruby on Rails
+applications.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Cabalist/ModelAdditions.html" title="Cabalist::ModelAdditions (module)">ModelAdditions</a></span>
+
+
+
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Cabalist/Configuration.html" title="Cabalist::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Cabalist/Frontend.html" title="Cabalist::Frontend (class)">Frontend</a></span>, <span class='object_link'><a href="Cabalist/Railtie.html" title="Cabalist::Railtie (class)">Railtie</a></span>
+
+
+</p>
+
+ <h2>Constant Summary</h2>
+
+ <dl class="constants">
+
+ <dt id="VERSION-constant" class="">VERSION =
+ <div class="docstring">
+ <div class="discussion">
+ <p>
+Version of the gem
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div>
+ </dt>
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.3</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+
+ </dl>
+
+
+
+
+
+
+
+ <h2>
+ Class Method Summary
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ </h2>
+
+ <ul class="summary">
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#configure-class_method" title="configure (class method)">+ (Cabalist::Configuration) <strong>configure</strong> {|Cabalist::Configuration.instance| ... }</a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Configure the application.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+ <div id="class_method_details" class="method_details_list">
+ <h2>Class Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="configure-class_method">
+
+ + (<tt><span class='object_link'><a href="Cabalist/Configuration.html" title="Cabalist::Configuration (class)">Cabalist::Configuration</a></span></tt>) <strong>configure</strong> {|Cabalist::Configuration.instance| ... }
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Configure the application
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Yields:</h3>
+<ul class="yield">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Cabalist/Configuration.html" title="Cabalist::Configuration (class)">Cabalist::Configuration</a></span>.instance</tt>)</span>
+
+
+
+ </li>
+
+</ul>
+<h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt><span class='object_link'><a href="Cabalist/Configuration.html" title="Cabalist::Configuration (class)">Cabalist::Configuration</a></span></tt>)</span>
+
+
+
+ &mdash;
+ <div class='inline'><p>
+library configuration singleton
+</p>
+</div>
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+14
+15
+16</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/cabalist.rb', line 14</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id configure'>configure</span>
+ <span class='kw'>yield</span> <span class='const'>Cabalist</span><span class='op'>::</span><span class='const'>Configuration</span><span class='period'>.</span><span class='id instance'>instance</span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Wed Apr 25 18:24:45 2012 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.7.2 (ruby-1.9.2).
+</div>
+
+ </body>
+</html>
Oops, something went wrong.

0 comments on commit 97d1ea1

Please sign in to comment.