KatanaCode/blogit

View on GitHub
doc/Blogit.html

Summary

Maintainability
Test Coverage
<!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: Blogit
  
    &mdash; Blogit - Add a blog to your Ruby on Rails application
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!Blogit.html";
</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>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index (B)</a> &raquo;
    
    
    <span class="title">Blogit</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 class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><h1>Module: Blogit
  
  
  
</h1>

<dl class="box">
  
  
    
  
    
  
  
  
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">lib/blogit.rb<span class="defines">,<br />
  lib/blogit/blogs.rb,<br /> lib/blogit/engine.rb,<br /> lib/blogit/version.rb,<br /> lib/blogit/archive.rb,<br /> app/models/blogit/post.rb,<br /> lib/blogit/archive/year.rb,<br /> lib/blogit/archive/list.rb,<br /> lib/blogit/archive/month.rb,<br /> lib/blogit/configuration.rb,<br /> app/models/blogit/comment.rb,<br /> lib/blogit/archive/archiveable.rb,<br /> app/helpers/blogit/posts_helper.rb,<br /> app/helpers/blogit/layout_helper.rb,<br /> lib/blogit/parsers/textile_parser.rb,<br /> app/helpers/blogit/comments_helper.rb,<br /> lib/generators/blogit/views_generator.rb,<br /> app/helpers/blogit/application_helper.rb,<br /> app/controllers/blogit/posts_controller.rb,<br /> lib/generators/blogit/install_generator.rb,<br /> app/controllers/blogit/comments_controller.rb,<br /> app/controllers/blogit/application_controller.rb,<br /> lib/generators/blogit/table_name_migration_generator.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="Blogit/ApplicationHelper.html" title="Blogit::ApplicationHelper (module)">ApplicationHelper</a></span>, <span class='object_link'><a href="Blogit/Archive.html" title="Blogit::Archive (module)">Archive</a></span>, <span class='object_link'><a href="Blogit/Blogs.html" title="Blogit::Blogs (module)">Blogs</a></span>, <span class='object_link'><a href="Blogit/CommentsHelper.html" title="Blogit::CommentsHelper (module)">CommentsHelper</a></span>, <span class='object_link'><a href="Blogit/Generators.html" title="Blogit::Generators (module)">Generators</a></span>, <span class='object_link'><a href="Blogit/LayoutHelper.html" title="Blogit::LayoutHelper (module)">LayoutHelper</a></span>, <span class='object_link'><a href="Blogit/Parsers.html" title="Blogit::Parsers (module)">Parsers</a></span>, <span class='object_link'><a href="Blogit/PostsHelper.html" title="Blogit::PostsHelper (module)">PostsHelper</a></span>, <span class='object_link'><a href="Blogit/Renderers.html" title="Blogit::Renderers (module)">Renderers</a></span>
    
  
    
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Blogit/ApplicationController.html" title="Blogit::ApplicationController (class)">ApplicationController</a></span>, <span class='object_link'><a href="Blogit/Comment.html" title="Blogit::Comment (class)">Comment</a></span>, <span class='object_link'><a href="Blogit/CommentsController.html" title="Blogit::CommentsController (class)">CommentsController</a></span>, <span class='object_link'><a href="Blogit/Configuration.html" title="Blogit::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Blogit/ConfigurationError.html" title="Blogit::ConfigurationError (class)">ConfigurationError</a></span>, <span class='object_link'><a href="Blogit/Engine.html" title="Blogit::Engine (class)">Engine</a></span>, <span class='object_link'><a href="Blogit/Post.html" title="Blogit::Post (class)">Post</a></span>, <span class='object_link'><a href="Blogit/PostsController.html" title="Blogit::PostsController (class)">PostsController</a></span>
    
  
</p>

  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="VERSION-constant" class="">VERSION =
          
        </dt>
        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.1.1</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="#configuration-class_method" title="configuration (class method)">+ (Object) <strong>configuration</strong> </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Blogit&#39;s global configuration.</p>
</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#configure-class_method" title="configure (class method)">+ (Object) <strong>configure</strong>(&amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'><p>Set global configuration options for Blogit.</p>
</div></span>
  
</li>

      
    </ul>
  



  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="configuration-class_method">
  
    + (<tt>Object</tt>) <strong>configuration</strong> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Blogit&#39;s global configuration.</p>


  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'></span>
      
      
      
        
        <div class='inline'><p>a Configuration</p>
</div>
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


27
28
29</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit.rb', line 27</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span>
  <span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="configure-class_method">
  
    + (<tt>Object</tt>) <strong>configure</strong>(&amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    <p>Set global configuration options for Blogit. <a href="file.README.html" title="read more">read more</a></p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


20
21
22</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/blogit.rb', line 20</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

    <div id="footer">
  Generated on Sat Oct 24 19:04:45 2015 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.6 (ruby-2.2.0).
</div>

  </body>
</html>