generate new docs

benjaminws · benjaminws · commit cdfa0e44a30b · 2012-11-20T12:08:30.000-05:00
diff --git a/docs/frame.html b/docs/frame.html
@@ -1,24 +1,4 @@
-<!DOCTYPE html>  <html> <head>   <title>frame.js</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="frame.html">                 frame.js               </a>                                           <a class="source" href="stomp-exceptions.html">                 stomp-exceptions.js               </a>                                           <a class="source" href="stomp-utils.html">                 stomp-utils.js               </a>                                           <a class="source" href="stomp.html">                 stomp.js               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               frame.js             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>                            </td>             <td class="code">               <div class="highlight"><pre><span class="cm">/*</span>
-<span class="cm">    frame.js - Frame object</span>
-
-<span class="cm">    Copyright (c) 2010, Benjamin W. Smith</span>
-<span class="cm">    All rights reserved.</span>
-
-<span class="cm">    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</span>
-
-<span class="cm">    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</span>
-<span class="cm">    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or</span>
-<span class="cm">      other materials provided with the distribution.</span>
-<span class="cm">    * Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software</span>
-<span class="cm">      without specific prior written permission.</span>
-
-<span class="cm">    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
-<span class="cm">    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE</span>
-<span class="cm">    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span>
-<span class="cm">    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span>
-<span class="cm">    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
-<span class="cm">    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
-<span class="cm">*/</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <h2>frame</h2>
+<!DOCTYPE html>  <html> <head>   <title>frame.js</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="frame.html">                 frame.js               </a>                                           <a class="source" href="stomp-exceptions.html">                 stomp-exceptions.js               </a>                                           <a class="source" href="stomp-utils.html">                 stomp-utils.js               </a>                                           <a class="source" href="stomp.html">                 stomp.js               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               frame.js             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>               <h2>frame</h2>
 
 <p>The <code>Frame</code> module provides an object representation of a <code>Stomp</code> frame.</p>
 
@@ -40,11 +20,11 @@ <h3>frame.Frame.build_frame()</h3>
 };
 
 this_frame = frame.build_frame(args);
-</code></pre>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <h2>Frame - Object representation of a STOMP frame</h2>             </td>             <td class="code">               <div class="highlight"><pre><span class="kd">function</span> <span class="nx">Frame</span><span class="p">()</span> <span class="p">{</span>
+</code></pre>             </td>             <td class="code">               <div class="highlight"><pre></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <h2>Frame - Object representation of a STOMP frame</h2>             </td>             <td class="code">               <div class="highlight"><pre><span class="kd">function</span> <span class="nx">Frame</span><span class="p">()</span> <span class="p">{</span>
     <span class="k">this</span><span class="p">.</span><span class="nx">command</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
     <span class="k">this</span><span class="p">.</span><span class="nx">headers</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
     <span class="k">this</span><span class="p">.</span><span class="nx">body</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
-<span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <h2>Frame.build<em>frame(args, want</em>receipt)</h2>
+<span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <h2>Frame.build<em>frame(args, want</em>receipt)</h2>
 
 <p><strong>Build frame based on arguments provided</strong></p>
 
@@ -71,7 +51,7 @@ <h3>frame.Frame.build_frame()</h3>
         <span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">&#39;receipt&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nx">_receipt</span><span class="p">;</span>
     <span class="p">}</span>
     <span class="k">return</span> <span class="k">this</span><span class="p">;</span>
-<span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <h2>Frame.as_string()</h2>
+<span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <h2>Frame.as_string()</h2>
 
 <p><strong>String representation of Frame object</strong></p>
 
diff --git a/docs/stomp-utils.html b/docs/stomp-utils.html
@@ -32,64 +32,13 @@
 
 <span class="nx">StompUtils</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">really_defined</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">var_to_test</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">return</span> <span class="o">!</span><span class="p">(</span><span class="nx">var_to_test</span> <span class="o">==</span> <span class="kc">null</span> <span class="o">||</span> <span class="nx">var_to_test</span> <span class="o">==</span> <span class="kc">undefined</span><span class="p">);</span>
-<span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Extend associative array</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nx">StompUtils</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">extend</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">destination</span><span class="p">,</span> <span class="nx">source</span><span class="p">)</span> <span class="p">{</span>
+<span class="p">};</span>
+
+<span class="nx">StompUtils</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">extend</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">destination</span><span class="p">,</span> <span class="nx">source</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">property</span> <span class="k">in</span> <span class="nx">source</span><span class="p">)</span> <span class="p">{</span>
         <span class="nx">destination</span><span class="p">[</span><span class="nx">property</span><span class="p">]</span> <span class="o">=</span> <span class="nx">source</span><span class="p">[</span><span class="nx">property</span><span class="p">];</span>
     <span class="p">}</span>
     <span class="k">return</span> <span class="nx">destination</span><span class="p">;</span>
 <span class="p">};</span>
 
-<span class="cm">/**</span>
-<span class="cm"> * Queueing implementation, blatantly ripped off from:</span>
-<span class="cm"> * http://safalra.com/web-design/javascript/queues/Queue.js</span>
-<span class="cm"> * only really semantics have been changed.</span>
-<span class="cm"> */</span>
-<span class="nx">StompQueue</span> <span class="o">=</span> <span class="nx">exports</span><span class="p">.</span><span class="nx">StompQueue</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
-    <span class="k">this</span><span class="p">.</span><span class="nx">queue</span> <span class="o">=</span> <span class="p">[];</span>
-    <span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
-<span class="p">};</span>
-
-<span class="nx">StompQueue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">get_size</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
-    <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">length</span> <span class="o">-</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span><span class="p">;</span>
-<span class="p">};</span>
-
-<span class="nx">StompQueue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">is_empty</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
-    <span class="k">return</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">length</span> <span class="o">==</span> <span class="mi">0</span><span class="p">);</span>
-<span class="p">};</span>
-
-<span class="nx">StompQueue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">put</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">item</span><span class="p">)</span> <span class="p">{</span>
-    <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
-<span class="p">};</span>
-
-<span class="nx">StompQueue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">get</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
-    <span class="kd">var</span> <span class="nx">item</span> <span class="o">=</span> <span class="kc">undefined</span><span class="p">;</span>
-
-    <span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span> <span class="p">{</span>
-        <span class="nx">item</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">[</span><span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span><span class="p">];</span>
-
-        <span class="k">if</span> <span class="p">(</span><span class="o">++</span><span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span> <span class="o">*</span> <span class="mi">2</span> <span class="o">&gt;=</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span> <span class="p">{</span>
-            <span class="k">this</span><span class="p">.</span><span class="nx">queue</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">slice</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span><span class="p">);</span>
-            <span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
-        <span class="p">}</span>
-    <span class="p">}</span>
-
-    <span class="k">if</span> <span class="p">(</span><span class="nx">item</span> <span class="o">==</span> <span class="kc">undefined</span><span class="p">)</span>
-        <span class="k">throw</span> <span class="k">new</span> <span class="nx">QueueEmpty</span><span class="p">();</span>
-
-    <span class="k">return</span> <span class="nx">item</span><span class="p">;</span>
-<span class="p">};</span>
-
-<span class="nx">StompQueue</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">get_oldest_item</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
-    <span class="kd">var</span> <span class="nx">item</span> <span class="o">=</span> <span class="kc">undefined</span><span class="p">;</span>
-
-    <span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span> <span class="p">{</span>
-        <span class="nx">item</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">queue</span><span class="p">[</span><span class="k">this</span><span class="p">.</span><span class="nx">queue_space</span><span class="p">];</span>
-    <span class="p">}</span>
-    <span class="k">else</span> <span class="p">{</span>
-        <span class="k">throw</span> <span class="k">new</span> <span class="nx">QueueEmpty</span><span class="p">();</span>
-    <span class="p">}</span>
-
-    <span class="k">return</span> <span class="nx">item</span><span class="p">;</span>
-<span class="p">};</span>
-
 </pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html> 
