Skip to content
This repository was archived by the owner on Nov 28, 2018. It is now read-only.

Commit 6812b8c

Browse files
benjaminwsbenjaminws
committed
Update the docs
1 parent 117f99c commit 6812b8c

8 files changed

+257
-12
lines changed

‎docs/bg.png

8.2 KB
Loading

‎docs/frame.html

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
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="index.html"> index.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>
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="rocco.css" /> </head> <body> <div id="navbar"> <h3>stomp-js - Implementation of the STOMP protocol in node.js<em></em></h3> </div> <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="index.html">Index</a> <a class="source" href="frame.html"> frame.js </a> <a class="source" href="index.html"> index.js </a> <a class="source" href="stomp.html"> stomp.js </a> <a class="source" href="stomp-utils.html"> stomp-utils.js </a> <a class="source" href="stomp-exceptions.html"> stomp-exceptions.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>
22

33
<p>The <code>Frame</code> module provides an object representation of a <code>Stomp</code> frame.</p>
44

55
<h3>frame.Frame</h3>
66

77
<p>An instance of the <code>Frame</code> object.</p>
88

9-
<pre><code>var frame = new frame.Frame();
10-
</code></pre>
9+
<pre><code>var frame = new frame.Frame();</code></pre>
1110

1211
<h3>frame.Frame.build_frame()</h3>
1312

@@ -19,8 +18,7 @@ <h3>frame.Frame.build_frame()</h3>
1918
body: ''
2019
};
2120

22-
this_frame = frame.build_frame(args);
23-
</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>
21+
this_frame = frame.build_frame(args);</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>
2422
<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>
2523
<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>
2624
<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>

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!DOCTYPE html> <html> <head> <title>index.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="index.html"> index.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> index.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> <h1>stomp-js</h1>
1+
<!DOCTYPE html> <html> <head> <title>index.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="rocco.css" /> </head> <body> <div id="navbar"> <h3>stomp-js - Implementation of the STOMP protocol in node.js<em></em></h3> </div> <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="index.html">Index</a> <a class="source" href="frame.html"> frame.js </a> <a class="source" href="index.html"> index.js </a> <a class="source" href="stomp.html"> stomp.js </a> <a class="source" href="stomp-utils.html"> stomp-utils.js </a> <a class="source" href="stomp-exceptions.html"> stomp-exceptions.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> index.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> <h1>stomp-js</h1>
22

33
<h2>Overview</h2>
44

‎docs/rocco.css

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

0 commit comments

Comments
 (0)