added the first set of documentation

author: Gibheer <gibheer@gmail.com> 2012-11-26 21:40:21 +0100
committer: Gibheer <gibheer@gmail.com> 2012-11-26 21:40:21 +0100
commit: 37a4a28deec224f7cd9a5a124e22258e868913e4 (patch)
tree: 23f8ce9b940ff1a357336344388cbcd46aa57ee7 /doc/Zero/Request/Accept.html
parent: 77a2cbe6d4e8752a9450e945724522d10cfb5f09 (diff)
1 files changed, 612 insertions, 0 deletions
diff --git a/doc/Zero/Request/Accept.html b/doc/Zero/Request/Accept.html
new file mode 100644
index 0000000..8a45ae0
--- /dev/null
+++ b/doc/Zero/Request/Accept.html
@@ -0,0 +1,612 @@
+<!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: Zero::Request::Accept
+  
+    &mdash; Documentation by YARD 0.8.3
+  
+</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">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
+</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 (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../Zero.html" title="Zero (module)">Zero</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Request.html" title="Zero::Request (class)">Request</a></span></span>
+     &raquo; 
+    <span class="title">Accept</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>Class: Zero::Request::Accept
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Zero::Request::Accept</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/zero/request/accept.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>encapsulates the accept header to easier work with this is partly copied
+from sinatra</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="MEDIA_TYPE_SEPERATOR-constant" class="">MEDIA_TYPE_SEPERATOR =
+          
+        </dt>
+        <dd><pre class="code"><span class='string val'>','</span>
+</pre></dd>
+      
+        <dt id="MEDIA_PARAM_SEPERATOR-constant" class="">MEDIA_PARAM_SEPERATOR =
+          
+        </dt>
+        <dd><pre class="code"><span class='string val'>';'</span>
+</pre></dd>
+      
+        <dt id="MEDIA_QUALITY_REGEX-constant" class="">MEDIA_QUALITY_REGEX =
+          
+        </dt>
+        <dd><pre class="code"><span class='regexp val'>/q=[01]\./</span>
+</pre></dd>
+      
+        <dt id="KEY_HTTP_ACCEPT-constant" class="">KEY_HTTP_ACCEPT =
+          
+        </dt>
+        <dd><pre class="code"><span class='string val'>'HTTP_ACCEPT'</span>
+</pre></dd>
+      
+        <dt id="KEY_HTTP_ACCEPT_LANGUAGE-constant" class="">KEY_HTTP_ACCEPT_LANGUAGE =
+          
+        </dt>
+        <dd><pre class="code"><span class='string val'>'HTTP_ACCEPT_LANGUAGE'</span>
+</pre></dd>
+      
+        <dt id="KEY_HTTP_ACCEPT_ENCODING-constant" class="">KEY_HTTP_ACCEPT_ENCODING =
+          
+        </dt>
+        <dd><pre class="code"><span class='string val'>'HTTP_ACCEPT_ENCODING'</span>
+</pre></dd>
+      
+    </dl>
+  
+
+
+
+
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#encoding-instance_method" title="#encoding (instance method)">- (Object) <strong>encoding</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute encoding.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#language-instance_method" title="#language (instance method)">- (Object) <strong>language</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute language.</p>
+</div></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#types-instance_method" title="#types (instance method)">- (Object) <strong>types</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute types.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <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="#map-class_method" title="map (class method)">+ (Object) <strong>map</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#map%3D-class_method" title="map= (class method)">+ (Object) <strong>map=</strong>(map) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+    </ul>
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Accept) <strong>initialize</strong>(environment) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>create a new accept object.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="Zero::Request::Accept (class)">Accept</a></span></tt>) <strong>initialize</strong>(environment) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>create a new accept object</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+25
+26
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 25</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='rparen token'>)</span>
+  <span class='rubyid_@types ivar id'>@types</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT constant id'>KEY_HTTP_ACCEPT</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
+  <span class='rubyid_@language ivar id'>@language</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT_LANGUAGE constant id'>KEY_HTTP_ACCEPT_LANGUAGE</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
+  <span class='rubyid_@encoding ivar id'>@encoding</span> <span class='assign token'>=</span> <span class='rubyid_AcceptType constant id'>AcceptType</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_environment identifier id'>environment</span><span class='lbrack token'>[</span><span class='rubyid_KEY_HTTP_ACCEPT_ENCODING constant id'>KEY_HTTP_ACCEPT_ENCODING</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="encoding-instance_method">
+  
+    - (<tt>Object</tt>) <strong>encoding</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute encoding</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+33
+34
+35</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 33</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_encoding identifier id'>encoding</span>
+  <span class='rubyid_@encoding ivar id'>@encoding</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="language-instance_method">
+  
+    - (<tt>Object</tt>) <strong>language</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute language</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 32</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_language identifier id'>language</span>
+  <span class='rubyid_@language ivar id'>@language</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="types-instance_method">
+  
+    - (<tt>Object</tt>) <strong>types</strong>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute types</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 31</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_types identifier id'>types</span>
+  <span class='rubyid_@types ivar id'>@types</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="map-class_method">
+  
+    + (<tt>Object</tt>) <strong>map</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 20</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span>
+  <span class='rubyid_@@map ivar id'>@@map</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="map=-class_method">
+  
+    + (<tt>Object</tt>) <strong>map=</strong>(map) 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/zero/request/accept.rb', line 16</span>
+
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_map identifier id'>map</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='rubyid_map identifier id'>map</span><span class='rparen token'>)</span>
+  <span class='rubyid_@@map ivar id'>@@map</span> <span class='assign token'>=</span> <span class='rubyid_map identifier id'>map</span>
+<span class='rubyid_end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Mon Nov 26 21:40:01 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.3 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>
+\ No newline at end of file
author	Gibheer <gibheer@gmail.com>	2012-11-26 21:40:21 +0100
committer	Gibheer <gibheer@gmail.com>	2012-11-26 21:40:21 +0100
commit	37a4a28deec224f7cd9a5a124e22258e868913e4 (patch)
tree	23f8ce9b940ff1a357336344388cbcd46aa57ee7 /doc/Zero/Request/Accept.html
parent	77a2cbe6d4e8752a9450e945724522d10cfb5f09 (diff)