doc/Reddit.html

<!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 name="Content-Type" content="text/html; charset=utf-8" />
<title>Module: Reddit</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 (R)</a> &raquo; 
    
    
    <span class="title">Reddit</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: Reddit
  
  
</h1>

<dl class="box">
  
  
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">lib/ruby_reddit_api/vote.rb<span class="defines">,<br />
  lib/ruby_reddit_api.rb,<br /> lib/ruby_reddit_api/api.rb,<br /> lib/ruby_reddit_api/user.rb,<br /> lib/ruby_reddit_api/base.rb,<br /> lib/ruby_reddit_api/thing.rb,<br /> lib/ruby_reddit_api/message.rb,<br /> lib/ruby_reddit_api/version.rb,<br /> lib/ruby_reddit_api/comment.rb,<br /> lib/ruby_reddit_api/submission.rb,<br /> lib/ruby_reddit_api/json_listing.rb</span>
</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    

  </div>
</div>
<div class="tags">
  <h3>Author:</h3>
<ul class="author">
  
    <li>
      
      
        <div class='inline'><p>
James Cook
</p>
</div>
      
    </li>
  
</ul>

</div><h2>Defined Under Namespace</h2>
<p class="children">
   
    
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Reddit/JsonListing.html" title="Reddit::JsonListing (module)">JsonListing</a></span>
    
   
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Reddit/Api.html" title="Reddit::Api (class)">Api</a></span>, <span class='object_link'><a href="Reddit/Base.html" title="Reddit::Base (class)">Base</a></span>, <span class='object_link'><a href="Reddit/Comment.html" title="Reddit::Comment (class)">Comment</a></span>, <span class='object_link'><a href="Reddit/Message.html" title="Reddit::Message (class)">Message</a></span>, <span class='object_link'><a href="Reddit/Submission.html" title="Reddit::Submission (class)">Submission</a></span>, <span class='object_link'><a href="Reddit/Thing.html" title="Reddit::Thing (class)">Thing</a></span>, <span class='object_link'><a href="Reddit/User.html" title="Reddit::User (class)">User</a></span>, <span class='object_link'><a href="Reddit/Vote.html" title="Reddit::Vote (class)">Vote</a></span>
    
  
</p>

  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="VERSION-constant" class="">VERSION =
          <div class="docstring">
  <div class="discussion">
    <p>
Capture the code version from the VERSION file
</p>


  </div>
</div>
<div class="tags">
  <h3>Returns:</h3>
<ul class="return">
  
    <li>
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
    </li>
  
</ul>

</div>
        </dt>
        <dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id exist?'>exist?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>VERSION</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>File</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>VERSION</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id chomp'>chomp</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span></pre></dd>
      
    </dl>
  

</div>
    
    <div id="footer">
  Generated on Sun Oct 10 01:18:34 2010 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.6.1 (ruby-1.9.2).
</div>

  </body>
</html>