Skip to content

Commit

Permalink
Regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@galfert
galfert committed Mar 27, 2012
1 parent c6c9e5e commit c8886a5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/app.html
View file
@@ -1,4 +1,4 @@
<!DOCTYPE html> <html> <head> <title>app.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> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> app.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="nx">require</span><span class="p">([</span><span class="s1">&#39;./js/tutorial&#39;</span><span class="p">,</span> <span class="s1">&#39;./js/helper&#39;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">storage</span><span class="p">,</span> <span class="nx">helper</span><span class="p">)</span> <span class="p">{</span> <!DOCTYPE html> <html> <head> <title>app.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> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> app.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="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">storage</span><span class="p">,</span> <span class="nx">helper</span><span class="p">)</span> <span class="p">{</span>


<span class="nx">$</span><span class="p">(</span><span class="kd">function</span><span class="p">()</span> <span class="p">{</span> <span class="nx">$</span><span class="p">(</span><span class="kd">function</span><span class="p">()</span> <span class="p">{</span>


Expand Down Expand Up @@ -107,6 +107,6 @@
<span class="nx">helper</span><span class="p">.</span><span class="nx">setAuthorizedState</span><span class="p">(</span><span class="nx">helper</span><span class="p">.</span><span class="nx">isAuthorized</span><span class="p">());</span> <span class="nx">helper</span><span class="p">.</span><span class="nx">setAuthorizedState</span><span class="p">(</span><span class="nx">helper</span><span class="p">.</span><span class="nx">isAuthorized</span><span class="p">());</span>
<span class="p">});</span> <span class="p">});</span>


<span class="p">});</span> <span class="p">})(</span><span class="nx">tutorial</span><span class="p">,</span> <span class="nx">helper</span><span class="p">);</span>


</pre></div> </td> </tr> </tbody> </table> </div> </body> </html> </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
6 changes: 3 additions & 3 deletions docs/token.html
View file
@@ -1,4 +1,4 @@
<!DOCTYPE html> <html> <head> <title>token.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> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> token.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></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <p><code>receiveToken</code> parses the OAuth token from the URL params</p> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">var</span> <span class="nx">token</span> <span class="o">=</span> <span class="nx">remoteStorage</span><span class="p">.</span><span class="nx">receiveToken</span><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> <p>We send the token <a href="tutorial.html">back to our main page</a></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nb">window</span><span class="p">.</span><span class="nx">opener</span><span class="p">.</span><span class="nx">postMessage</span><span class="p">(</span><span class="nx">token</span><span class="p">,</span> <span class="nx">location</span><span class="p">.</span><span class="nx">protocol</span><span class="o">+</span><span class="s1">&#39;//&#39;</span><span class="o">+</span><span class="nx">location</span><span class="p">.</span><span class="nx">host</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> <p>and close the window.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nb">window</span><span class="p">.</span><span class="nx">close</span><span class="p">();</span> <!DOCTYPE html> <html> <head> <title>token.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> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> token.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="p">(</span><span class="kd">function</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><code>receiveToken</code> parses the OAuth token from the URL params</p> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">var</span> <span class="nx">token</span> <span class="o">=</span> <span class="nx">remoteStorage</span><span class="p">.</span><span class="nx">receiveToken</span><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> <p>We send the token <a href="tutorial.html">back to our main page</a></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nb">window</span><span class="p">.</span><span class="nx">opener</span><span class="p">.</span><span class="nx">postMessage</span><span class="p">(</span><span class="nx">token</span><span class="p">,</span> <span class="nx">location</span><span class="p">.</span><span class="nx">protocol</span><span class="o">+</span><span class="s1">&#39;//&#39;</span><span class="o">+</span><span class="nx">location</span><span class="p">.</span><span class="nx">host</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> <p>and close the window.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nb">window</span><span class="p">.</span><span class="nx">close</span><span class="p">();</span>
<span class="p">})();</span>



</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
6 changes: 3 additions & 3 deletions docs/tutorial.html
View file
@@ -1,4 +1,4 @@
<!DOCTYPE html> <html> <head> <title>tutorial.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> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> tutorial.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>Accepting remoteStorage accounts in your web app</h2> </td> <td class="code"> <div class="highlight"><pre><span class="nx">define</span><span class="p">([</span><span class="s1">&#39;./helper&#39;</span><span class="p">],</span> <span class="kd">function</span><span class="p">(</span><span class="nx">helper</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><code>getStorageInfo</code> takes a user address ("user@host") and a callback as its <!DOCTYPE html> <html> <head> <title>tutorial.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> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> tutorial.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>Accepting remoteStorage accounts in your web app</h2> </td> <td class="code"> <div class="highlight"><pre><span class="kd">var</span> <span class="nx">tutorial</span> <span class="o">=</span> <span class="p">(</span><span class="kd">function</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><code>getStorageInfo</code> takes a user address ("user@host") and a callback as its
arguments. The callback will get an error code, and a <code>storageInfo</code> arguments. The callback will get an error code, and a <code>storageInfo</code>
object. If the error code is <code>null</code>, then the <code>storageInfo</code> object will object. If the error code is <code>null</code>, then the <code>storageInfo</code> object will
contain data required to access the remoteStorage.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">function</span> <span class="nx">connect</span><span class="p">(</span><span class="nx">userAddress</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span> contain data required to access the remoteStorage.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">function</span> <span class="nx">connect</span><span class="p">(</span><span class="nx">userAddress</span><span class="p">,</span> <span class="nx">callback</span><span class="p">)</span> <span class="p">{</span>
Expand Down Expand Up @@ -84,6 +84,6 @@
<span class="nx">putData</span><span class="o">:</span> <span class="nx">putData</span><span class="p">,</span> <span class="nx">putData</span><span class="o">:</span> <span class="nx">putData</span><span class="p">,</span>
<span class="p">};</span> <span class="p">};</span>


<span class="p">});</span> <span class="p">})();</span>


</pre></div> </td> </tr> </tbody> </table> </div> </body> </html> </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>

0 comments on commit c8886a5

Please sign in to comment.