ShogunPanda/ballast

View on GitHub
docs/_index.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>
  Documentation by YARD 0.8.7.6
  
</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#!_index.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">
  

  <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 class="noborder title">Documentation by YARD 0.8.7.6</h1>
<div id="listing">
  <h1 class="alphaindex">Alphabetic Index</h1>
  
  <h2>File Listing</h2>
  <ul id="files" class="index_inline_list">
  
  
    <li class="r1"><a href="index.html" title="README">README</a></li>
    
  
  </ul>

<div class="clear"></div>
<h2>Namespace Listing A-Z</h2>




<table>
  <tr>
    <td valign='top' width="33%">
      
        
        <ul id="alpha_A" class="alpha">
          <li class="letter">A</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/AjaxHandling.html" title="Ballast::Concerns::AjaxHandling (module)">AjaxHandling</a></span>
                
                  <small>(Ballast::Concerns)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/AjaxResponse.html" title="Ballast::AjaxResponse (class)">AjaxResponse</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_B" class="alpha">
          <li class="letter">B</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast.html" title="Ballast (module)">Ballast</a></span>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Errors/Base.html" title="Ballast::Errors::Base (class)">Base</a></span>
                
                  <small>(Ballast::Errors)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_C" class="alpha">
          <li class="letter">C</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Emoji/Character.html" title="Ballast::Emoji::Character (module)">Character</a></span>
                
                  <small>(Ballast::Emoji)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/Common.html" title="Ballast::Concerns::Common (module)">Common</a></span>
                
                  <small>(Ballast::Concerns)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns.html" title="Ballast::Concerns (module)">Concerns</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Configuration.html" title="Ballast::Configuration (class)">Configuration</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_D" class="alpha">
          <li class="letter">D</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Middlewares/DefaultHost.html" title="Ballast::Middlewares::DefaultHost (class)">DefaultHost</a></span>
                
                  <small>(Ballast::Middlewares)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_E" class="alpha">
          <li class="letter">E</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Emoji.html" title="Ballast::Emoji (module)">Emoji</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Errors.html" title="Ballast::Errors (module)">Errors</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/ErrorsHandling.html" title="Ballast::Concerns::ErrorsHandling (module)">ErrorsHandling</a></span>
                
                  <small>(Ballast::Concerns)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_F" class="alpha">
          <li class="letter">F</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Errors/Failure.html" title="Ballast::Errors::Failure (class)">Failure</a></span>
                
                  <small>(Ballast::Errors)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_I" class="alpha">
          <li class="letter">I</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Errors/InvalidDomain.html" title="Ballast::Errors::InvalidDomain (class)">InvalidDomain</a></span>
                
                  <small>(Ballast::Errors)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
          </td><td valign='top' width="33%">
          
        
        <ul id="alpha_J" class="alpha">
          <li class="letter">J</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/JSONApi.html" title="Ballast::Concerns::JSONApi (module)">JSONApi</a></span>
                
                  <small>(Ballast::Concerns)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_M" class="alpha">
          <li class="letter">M</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Middlewares.html" title="Ballast::Middlewares (module)">Middlewares</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_P" class="alpha">
          <li class="letter">P</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/JSONApi/PaginationHandling.html" title="Ballast::Concerns::JSONApi::PaginationHandling (module)">PaginationHandling</a></span>
                
                  <small>(Ballast::Concerns::JSONApi)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_R" class="alpha">
          <li class="letter">R</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/RequestDomainMatcher.html" title="Ballast::RequestDomainMatcher (class)">RequestDomainMatcher</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/JSONApi/RequestHandling.html" title="Ballast::Concerns::JSONApi::RequestHandling (module)">RequestHandling</a></span>
                
                  <small>(Ballast::Concerns::JSONApi)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Service/Response.html" title="Ballast::Service::Response (class)">Response</a></span>
                
                  <small>(Ballast::Service)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/JSONApi/ResponseHandling.html" title="Ballast::Concerns::JSONApi::ResponseHandling (module)">ResponseHandling</a></span>
                
                  <small>(Ballast::Concerns::JSONApi)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_S" class="alpha">
          <li class="letter">S</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Service.html" title="Ballast::Service (class)">Service</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_U" class="alpha">
          <li class="letter">U</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Emoji/Utils.html" title="Ballast::Emoji::Utils (module)">Utils</a></span>
                
                  <small>(Ballast::Emoji)</small>
                
              </li>
            
          </ul>
        </ul>
      
        
        <ul id="alpha_V" class="alpha">
          <li class="letter">V</li>
          <ul>
            
              <li>
                <span class='object_link'><a href="Ballast/Errors/ValidationFailure.html" title="Ballast::Errors::ValidationFailure (class)">ValidationFailure</a></span>
                
                  <small>(Ballast::Errors)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Version.html" title="Ballast::Version (module)">Version</a></span>
                
                  <small>(Ballast)</small>
                
              </li>
            
              <li>
                <span class='object_link'><a href="Ballast/Concerns/View.html" title="Ballast::Concerns::View (module)">View</a></span>
                
                  <small>(Ballast::Concerns)</small>
                
              </li>
            
          </ul>
        </ul>
      
    </td>
  </tr>
</table>

</div>

</div>

    <div id="footer">
  Generated on Thu Aug 18 15:49:48 2016 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.6 (ruby-2.3.0).
</div>

  </body>
</html>