Permalink
Browse files

[doc] Update docco docs

  • Loading branch information...
1 parent f530318 commit 4a09612fd846fcd2514ab03a02c3882dc462389a @indexzero indexzero committed Aug 9, 2011
View
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
@@ -1,16 +1,11 @@
-<!DOCTYPE html> <html> <head> <title>client.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="../..//haibu/balancer/balancer.html"> haibu/balancer/balancer.html </a> <a class="source" href="../..//haibu/balancer/index.html"> haibu/balancer/index.html </a> <a class="source" href="../..//haibu/core/config.html"> haibu/core/config.html </a> <a class="source" href="../..//haibu/core/process-store.html"> haibu/core/process-store.html </a> <a class="source" href="../..//haibu/core/spawner.html"> haibu/core/spawner.html </a> <a class="source" href="../..//haibu/drone/client.html"> haibu/drone/client.html </a> <a class="source" href="../..//haibu/drone/drone.html"> haibu/drone/drone.html </a> <a class="source" href="../..//haibu/drone/index.html"> haibu/drone/index.html </a> <a class="source" href="../..//haibu/drone/service.html"> haibu/drone/service.html </a> <a class="source" href="../..//haibu/plugins/changelog.html"> haibu/plugins/changelog.html </a> <a class="source" href="../..//haibu/plugins/chroot.html"> haibu/plugins/chroot.html </a> <a class="source" href="../..//haibu/plugins/logger.html"> haibu/plugins/logger.html </a> <a class="source" href="../..//haibu/repositories/git.html"> haibu/repositories/git.html </a> <a class="source" href="../..//haibu/repositories/index.html"> haibu/repositories/index.html </a> <a class="source" href="../..//haibu/repositories/local-file.html"> haibu/repositories/local-file.html </a> <a class="source" href="../..//haibu/repositories/npm.html"> haibu/repositories/npm.html </a> <a class="source" href="../..//haibu/repositories/remote-file.html"> haibu/repositories/remote-file.html </a> <a class="source" href="../..//haibu/repositories/repository.html"> haibu/repositories/repository.html </a> <a class="source" href="../..//haibu/repositories/tar.html"> haibu/repositories/tar.html </a> <a class="source" href="../..//haibu/repositories/zip.html"> haibu/repositories/zip.html </a> <a class="source" href="../..//haibu/utils/base64.html"> haibu/utils/base64.html </a> <a class="source" href="../..//haibu/utils/bin.html"> haibu/utils/bin.html </a> <a class="source" href="../..//haibu/utils/index.html"> haibu/utils/index.html </a> <a class="source" href="../..//haibu/utils/npm.html"> haibu/utils/npm.html </a> <a class="source" href="../..//haibu.html"> haibu.html </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> client.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>
+<!DOCTYPE html> <html> <head> <title>client.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="../..//haibu/balancer/balancer.html"> haibu/balancer/balancer.html </a> <a class="source" href="../..//haibu/balancer/index.html"> haibu/balancer/index.html </a> <a class="source" href="../..//haibu/cli/apps.html"> haibu/cli/apps.html </a> <a class="source" href="../..//haibu/cli/config.html"> haibu/cli/config.html </a> <a class="source" href="../..//haibu/core/config.html"> haibu/core/config.html </a> <a class="source" href="../..//haibu/core/spawner.html"> haibu/core/spawner.html </a> <a class="source" href="../..//haibu/drone/client.html"> haibu/drone/client.html </a> <a class="source" href="../..//haibu/drone/drone.html"> haibu/drone/drone.html </a> <a class="source" href="../..//haibu/drone/index.html"> haibu/drone/index.html </a> <a class="source" href="../..//haibu/drone/service.html"> haibu/drone/service.html </a> <a class="source" href="../..//haibu/plugins/changelog.html"> haibu/plugins/changelog.html </a> <a class="source" href="../..//haibu/plugins/chroot.html"> haibu/plugins/chroot.html </a> <a class="source" href="../..//haibu/plugins/logger.html"> haibu/plugins/logger.html </a> <a class="source" href="../..//haibu/repositories/git.html"> haibu/repositories/git.html </a> <a class="source" href="../..//haibu/repositories/index.html"> haibu/repositories/index.html </a> <a class="source" href="../..//haibu/repositories/local-file.html"> haibu/repositories/local-file.html </a> <a class="source" href="../..//haibu/repositories/npm.html"> haibu/repositories/npm.html </a> <a class="source" href="../..//haibu/repositories/remote-file.html"> haibu/repositories/remote-file.html </a> <a class="source" href="../..//haibu/repositories/repository.html"> haibu/repositories/repository.html </a> <a class="source" href="../..//haibu/repositories/tar.html"> haibu/repositories/tar.html </a> <a class="source" href="../..//haibu/repositories/zip.html"> haibu/repositories/zip.html </a> <a class="source" href="../..//haibu/utils/base64.html"> haibu/utils/base64.html </a> <a class="source" href="../..//haibu/utils/bin.html"> haibu/utils/bin.html </a> <a class="source" href="../..//haibu/utils/index.html"> haibu/utils/index.html </a> <a class="source" href="../..//haibu/utils/npm.html"> haibu/utils/npm.html </a> <a class="source" href="../..//haibu.html"> haibu.html </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> client.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"> * client.js: API Client for the haibu Drone API.</span>
<span class="cm"> *</span>
<span class="cm"> * (C) 2010, Nodejitsu Inc.</span>
<span class="cm"> *</span>
<span class="cm"> */</span>
-<span class="kd">var</span> <span class="nx">sys</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;sys&#39;</span><span class="p">),</span>
- <span class="nx">fs</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;fs&#39;</span><span class="p">),</span>
- <span class="nx">path</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;path&#39;</span><span class="p">),</span>
- <span class="nx">eyes</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;eyes&#39;</span><span class="p">),</span>
- <span class="nx">request</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;request&#39;</span><span class="p">),</span>
- <span class="nx">haibu</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;haibu&#39;</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>Failure HTTP Response codes based
+<span class="kd">var</span> <span class="nx">request</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;request&#39;</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>Failure HTTP Response codes based
off of <code>/lib/haibu/drone/service.js</code></p> </td> <td class="code"> <div class="highlight"><pre><span class="kd">var</span> <span class="nx">failCodes</span> <span class="o">=</span> <span class="p">{</span>
<span class="mi">400</span><span class="o">:</span> <span class="s1">&#39;Bad Request&#39;</span><span class="p">,</span>
<span class="mi">404</span><span class="o">:</span> <span class="s1">&#39;Item not found&#39;</span><span class="p">,</span>
@@ -27,7 +22,7 @@
<span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">&#39;options.host is required.&#39;</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> <p>TODO (indexzero): Configure the drone port globally somewhere.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">options</span> <span class="o">=</span> <span class="nx">options</span><span class="p">;</span>
- <span class="k">this</span><span class="p">.</span><span class="nx">options</span><span class="p">.</span><span class="nx">port</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">options</span><span class="p">.</span><span class="nx">port</span> <span class="o">||</span> <span class="mi">9000</span><span class="p">;</span>
+ <span class="k">this</span><span class="p">.</span><span class="nx">options</span><span class="p">.</span><span class="nx">port</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">options</span><span class="p">.</span><span class="nx">port</span> <span class="o">||</span> <span class="mi">9002</span><span class="p">;</span>
<span class="p">};</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> <h3>function get (name, callback)</h3>
<h4>@name {string} name of the application to get from the Haibu server.</h4>
Oops, something went wrong.

0 comments on commit 4a09612

Please sign in to comment.