Skip to content

Commit 7fdffc2

Browse files
benjaminwsbenjaminws
committed
Add docco docs
1 parent c5d1e07 commit 7fdffc2

File tree

5 files changed

+753
-0
lines changed

5 files changed

+753
-0
lines changed

‎docs/docco.css

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
/*--------------------- Layout and Typography ----------------------------*/
2+
body {
3+
font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
4+
font-size: 15px;
5+
line-height: 22px;
6+
color: #252519;
7+
margin: 0; padding: 0;
8+
}
9+
a {
10+
color: #261a3b;
11+
}
12+
a:visited {
13+
color: #261a3b;
14+
}
15+
p {
16+
margin: 0 0 15px 0;
17+
}
18+
h1, h2, h3, h4, h5, h6 {
19+
margin: 0px 0 15px 0;
20+
}
21+
h1 {
22+
margin-top: 40px;
23+
}
24+
hr {
25+
border: 0 none;
26+
border-top: 1px solid #e5e5ee;
27+
height: 1px;
28+
margin: 20px 0;
29+
}
30+
#container {
31+
position: relative;
32+
}
33+
#background {
34+
position: fixed;
35+
top: 0; left: 525px; right: 0; bottom: 0;
36+
background: #f5f5ff;
37+
border-left: 1px solid #e5e5ee;
38+
z-index: -1;
39+
}
40+
#jump_to, #jump_page {
41+
background: white;
42+
-webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
43+
-webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
44+
font: 10px Arial;
45+
text-transform: uppercase;
46+
cursor: pointer;
47+
text-align: right;
48+
}
49+
#jump_to, #jump_wrapper {
50+
position: fixed;
51+
right: 0; top: 0;
52+
padding: 5px 10px;
53+
}
54+
#jump_wrapper {
55+
padding: 0;
56+
display: none;
57+
}
58+
#jump_to:hover #jump_wrapper {
59+
display: block;
60+
}
61+
#jump_page {
62+
padding: 5px 0 3px;
63+
margin: 0 0 25px 25px;
64+
}
65+
#jump_page .source {
66+
display: block;
67+
padding: 5px 10px;
68+
text-decoration: none;
69+
border-top: 1px solid #eee;
70+
}
71+
#jump_page .source:hover {
72+
background: #f5f5ff;
73+
}
74+
#jump_page .source:first-child {
75+
}
76+
table td {
77+
border: 0;
78+
outline: 0;
79+
}
80+
td.docs, th.docs {
81+
max-width: 450px;
82+
min-width: 450px;
83+
min-height: 5px;
84+
padding: 10px 25px 1px 50px;
85+
overflow-x: hidden;
86+
vertical-align: top;
87+
text-align: left;
88+
}
89+
.docs pre {
90+
margin: 15px 0 15px;
91+
padding-left: 15px;
92+
}
93+
.docs p tt, .docs p code {
94+
background: #f8f8ff;
95+
border: 1px solid #dedede;
96+
font-size: 12px;
97+
padding: 0 0.2em;
98+
}
99+
.pilwrap {
100+
position: relative;
101+
}
102+
.pilcrow {
103+
font: 12px Arial;
104+
text-decoration: none;
105+
color: #454545;
106+
position: absolute;
107+
top: 3px; left: -20px;
108+
padding: 1px 2px;
109+
opacity: 0;
110+
-webkit-transition: opacity 0.2s linear;
111+
}
112+
td.docs:hover .pilcrow {
113+
opacity: 1;
114+
}
115+
td.code, th.code {
116+
padding: 14px 15px 16px 25px;
117+
width: 100%;
118+
vertical-align: top;
119+
background: #f5f5ff;
120+
border-left: 1px solid #e5e5ee;
121+
}
122+
pre, tt, code {
123+
font-size: 12px; line-height: 18px;
124+
font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace;
125+
margin: 0; padding: 0;
126+
}
127+
128+
129+
/*---------------------- Syntax Highlighting -----------------------------*/
130+
td.linenos { background-color: #f0f0f0; padding-right: 10px; }
131+
span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
132+
body .hll { background-color: #ffffcc }
133+
body .c { color: #408080; font-style: italic } /* Comment */
134+
body .err { border: 1px solid #FF0000 } /* Error */
135+
body .k { color: #954121 } /* Keyword */
136+
body .o { color: #666666 } /* Operator */
137+
body .cm { color: #408080; font-style: italic } /* Comment.Multiline */
138+
body .cp { color: #BC7A00 } /* Comment.Preproc */
139+
body .c1 { color: #408080; font-style: italic } /* Comment.Single */
140+
body .cs { color: #408080; font-style: italic } /* Comment.Special */
141+
body .gd { color: #A00000 } /* Generic.Deleted */
142+
body .ge { font-style: italic } /* Generic.Emph */
143+
body .gr { color: #FF0000 } /* Generic.Error */
144+
body .gh { color: #000080; font-weight: bold } /* Generic.Heading */
145+
body .gi { color: #00A000 } /* Generic.Inserted */
146+
body .go { color: #808080 } /* Generic.Output */
147+
body .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
148+
body .gs { font-weight: bold } /* Generic.Strong */
149+
body .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
150+
body .gt { color: #0040D0 } /* Generic.Traceback */
151+
body .kc { color: #954121 } /* Keyword.Constant */
152+
body .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */
153+
body .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */
154+
body .kp { color: #954121 } /* Keyword.Pseudo */
155+
body .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */
156+
body .kt { color: #B00040 } /* Keyword.Type */
157+
body .m { color: #666666 } /* Literal.Number */
158+
body .s { color: #219161 } /* Literal.String */
159+
body .na { color: #7D9029 } /* Name.Attribute */
160+
body .nb { color: #954121 } /* Name.Builtin */
161+
body .nc { color: #0000FF; font-weight: bold } /* Name.Class */
162+
body .no { color: #880000 } /* Name.Constant */
163+
body .nd { color: #AA22FF } /* Name.Decorator */
164+
body .ni { color: #999999; font-weight: bold } /* Name.Entity */
165+
body .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
166+
body .nf { color: #0000FF } /* Name.Function */
167+
body .nl { color: #A0A000 } /* Name.Label */
168+
body .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
169+
body .nt { color: #954121; font-weight: bold } /* Name.Tag */
170+
body .nv { color: #19469D } /* Name.Variable */
171+
body .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
172+
body .w { color: #bbbbbb } /* Text.Whitespace */
173+
body .mf { color: #666666 } /* Literal.Number.Float */
174+
body .mh { color: #666666 } /* Literal.Number.Hex */
175+
body .mi { color: #666666 } /* Literal.Number.Integer */
176+
body .mo { color: #666666 } /* Literal.Number.Oct */
177+
body .sb { color: #219161 } /* Literal.String.Backtick */
178+
body .sc { color: #219161 } /* Literal.String.Char */
179+
body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */
180+
body .s2 { color: #219161 } /* Literal.String.Double */
181+
body .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
182+
body .sh { color: #219161 } /* Literal.String.Heredoc */
183+
body .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
184+
body .sx { color: #954121 } /* Literal.String.Other */
185+
body .sr { color: #BB6688 } /* Literal.String.Regex */
186+
body .s1 { color: #219161 } /* Literal.String.Single */
187+
body .ss { color: #19469D } /* Literal.String.Symbol */
188+
body .bp { color: #954121 } /* Name.Builtin.Pseudo */
189+
body .vc { color: #19469D } /* Name.Variable.Class */
190+
body .vg { color: #19469D } /* Name.Variable.Global */
191+
body .vi { color: #19469D } /* Name.Variable.Instance */
192+
body .il { color: #666666 } /* Literal.Number.Integer.Long */

‎docs/frame.html

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<!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>
2+
<span class="cm"> frame.js - Frame object</span>
3+
4+
<span class="cm"> Copyright (c) 2010, Benjamin W. Smith</span>
5+
<span class="cm"> All rights reserved.</span>
6+
7+
<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>
8+
9+
<span class="cm"> * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</span>
10+
<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>
11+
<span class="cm"> other materials provided with the distribution.</span>
12+
<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>
13+
<span class="cm"> without specific prior written permission.</span>
14+
15+
<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>
16+
<span class="cm"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE</span>
17+
<span class="cm"> COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span>
18+
<span class="cm"> (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span>
19+
<span class="cm"> HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
20+
<span class="cm"> ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
21+
<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>
22+
23+
<p>The <code>Frame</code> module provides an object representation of a <code>Stomp</code> frame.</p>
24+
25+
<h3>frame.Frame</h3>
26+
27+
<p>An instance of the <code>Frame</code> object.</p>
28+
29+
<pre><code>var frame = new frame.Frame();
30+
</code></pre>
31+
32+
<h3>frame.Frame.build_frame()</h3>
33+
34+
<p>Build a frame object from an object of arguments.</p>
35+
36+
<pre><code>var args = {
37+
command: '',
38+
headers: {},
39+
body: ''
40+
};
41+
42+
this_frame = frame.build_frame(args);
43+
</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>
44+
<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>
45+
<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>
46+
<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>
47+
<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>
48+
49+
<p><strong>Build frame based on arguments provided</strong></p>
50+
51+
<p>Takes arguments object needed to build frame (command, headers, body?)</p>
52+
53+
<p>Takes boolean to indicate that you wish to get a receipt (set receipt header)</p>
54+
55+
<p>Returns an object representing a frame</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Frame</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">build_frame</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">args</span><span class="p">,</span> <span class="nx">want_receipt</span><span class="p">)</span> <span class="p">{</span>
56+
<span class="kd">var</span> <span class="nx">receipt_stamp</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
57+
58+
<span class="k">this</span><span class="p">.</span><span class="nx">command</span> <span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="s1">&#39;command&#39;</span><span class="p">];</span>
59+
<span class="k">this</span><span class="p">.</span><span class="nx">headers</span> <span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="s1">&#39;headers&#39;</span><span class="p">];</span>
60+
<span class="k">this</span><span class="p">.</span><span class="nx">body</span> <span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="s1">&#39;body&#39;</span><span class="p">];</span>
61+
62+
<span class="k">if</span> <span class="p">(</span><span class="nx">want_receipt</span><span class="p">)</span> <span class="p">{</span>
63+
<span class="kd">var</span> <span class="nx">_receipt</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
64+
<span class="nx">receipt_stamp</span> <span class="o">=</span> <span class="nb">Math</span><span class="p">.</span><span class="nx">floor</span><span class="p">(</span><span class="nb">Math</span><span class="p">.</span><span class="nx">random</span><span class="p">()</span><span class="o">*</span><span class="mi">99999999999</span><span class="p">).</span><span class="nx">toString</span><span class="p">();</span>
65+
<span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">&#39;session&#39;</span><span class="p">]</span> <span class="o">!=</span> <span class="kc">undefined</span><span class="p">)</span> <span class="p">{</span>
66+
<span class="nx">_receipt</span> <span class="o">=</span> <span class="nx">receipt_stamp</span> <span class="o">+</span> <span class="s2">&quot;-&quot;</span> <span class="o">+</span> <span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">&#39;session&#39;</span><span class="p">];</span>
67+
<span class="p">}</span>
68+
<span class="k">else</span> <span class="p">{</span>
69+
<span class="nx">_receipt</span> <span class="o">=</span> <span class="nx">receipt_stamp</span><span class="p">;</span>
70+
<span class="p">}</span>
71+
<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>
72+
<span class="p">}</span>
73+
<span class="k">return</span> <span class="k">this</span><span class="p">;</span>
74+
<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>
75+
76+
<p><strong>String representation of Frame object</strong></p>
77+
78+
<p>Returns <code>Frame</code> as string</p> </td> <td class="code"> <div class="highlight"><pre><span class="nx">Frame</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">as_string</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
79+
<span class="kd">var</span> <span class="nx">header_strs</span> <span class="o">=</span> <span class="p">[],</span>
80+
<span class="nx">frame</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
81+
<span class="nx">command</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">command</span><span class="p">,</span>
82+
<span class="nx">headers</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">headers</span><span class="p">,</span>
83+
<span class="nx">body</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">body</span><span class="p">;</span>
84+
85+
<span class="k">for</span> <span class="p">(</span><span class="kd">var</span> <span class="nx">header</span> <span class="k">in</span> <span class="nx">headers</span><span class="p">)</span> <span class="p">{</span>
86+
<span class="nx">header_strs</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">header</span> <span class="o">+</span> <span class="s1">&#39;:&#39;</span> <span class="o">+</span> <span class="nx">headers</span><span class="p">[</span><span class="nx">header</span><span class="p">]);</span>
87+
<span class="p">}</span>
88+
89+
<span class="nx">frame</span> <span class="o">+=</span> <span class="nx">command</span> <span class="o">+</span> <span class="s2">&quot;\n&quot;</span><span class="p">;</span>
90+
<span class="nx">frame</span> <span class="o">+=</span> <span class="nx">header_strs</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s2">&quot;\n&quot;</span><span class="p">);</span>
91+
<span class="nx">frame</span> <span class="o">+=</span> <span class="s2">&quot;\n\n&quot;</span><span class="p">;</span>
92+
93+
<span class="k">if</span><span class="p">(</span><span class="nx">body</span><span class="p">)</span> <span class="p">{</span>
94+
<span class="nx">frame</span> <span class="o">+=</span> <span class="nx">body</span><span class="p">;</span>
95+
<span class="p">}</span>
96+
97+
<span class="nx">frame</span> <span class="o">+=</span> <span class="s1">&#39;\x00&#39;</span><span class="p">;</span>
98+
99+
<span class="k">return</span> <span class="nx">frame</span><span class="p">;</span>
100+
<span class="p">};</span>
101+
102+
<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span><span class="p">.</span><span class="nx">Frame</span> <span class="o">=</span> <span class="nx">Frame</span><span class="p">;</span>
103+
104+
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>

0 commit comments

Comments
 (0)