Skip to content

Commit

Permalink
new version
Browse files Browse the repository at this point in the history
  • Loading branch information
tarunc committed Apr 25, 2015
1 parent 59030bd commit 208a1ea
Show file tree
Hide file tree
Showing 8 changed files with 1,540 additions and 255 deletions.
21 changes: 20 additions & 1 deletion Gruntfile.js
Expand Up @@ -55,6 +55,25 @@ module.exports = function ConfigureGruntService(grunt) {
files: {
src: ['lib/*.js', 'index.js', 'Gruntfile.js']
}
},
'gh-pages': {
options: {
base: 'docs',
push: true,
message: 'Auto-generated commit'
},
src: '**/*'
},
copy: {
docs: {
files: [{
src: ['docs/lib/intercom.io.js.html'],
dest: './docs/index.html'
}, {
src: ['docs/lib/*.html'],
dest: './docs/'
}]
}
}
});

Expand All @@ -68,7 +87,7 @@ module.exports = function ConfigureGruntService(grunt) {
// Running `grunt doc` will generate documentation for Quad.
// The documentation will be put into the `./docs` folder in project's root
// folder.
grunt.registerTask('doc', ['docker', 'shell:sweetenDocker']);
grunt.registerTask('doc', ['docker', 'shell:sweetenDocker', 'copy:docs']);
// @note `grunt docs` provides an alias for the `grunt doc` task
grunt.registerTask('docs', ['doc']);
};
30 changes: 24 additions & 6 deletions docs/IntercomError.js.html
Expand Up @@ -40,7 +40,10 @@ <h1>IntercomError.js</h1>
<a class="pilcrow" href="#section-1" id="section-1">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Module dependencies.</p>
<div class="summary">
<p>
Module dependencies.
</p>
</div>
<div class="body">
</div>
Expand All @@ -58,7 +61,10 @@ <h1>IntercomError.js</h1>
<a class="pilcrow" href="#section-2" id="section-2">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p><code>AbstractError</code> error.</p>
<div class="summary">
<p>
<code>AbstractError</code> error.
</p>
</div>
<div class="body">
</div>
Expand Down Expand Up @@ -90,7 +96,10 @@ <h1>IntercomError.js</h1>
<a class="pilcrow" href="#section-3" id="section-3">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Inherit from <code>Error</code>.</p>
<div class="summary">
<p>
Inherit from <code>Error</code>.
</p>
</div>
<div class="body">
</div>
Expand All @@ -109,7 +118,10 @@ <h1>IntercomError.js</h1>
<a class="pilcrow" href="#section-4" id="section-4">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p><code>IntercomError</code> error.</p>
<div class="summary">
<p>
<code>IntercomError</code> error.
</p>
</div>
<div class="body">
</div>
Expand Down Expand Up @@ -139,7 +151,10 @@ <h1>IntercomError.js</h1>
<a class="pilcrow" href="#section-5" id="section-5">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Inherit from <code>AbstractError</code>.</p>
<div class="summary">
<p>
Inherit from <code>AbstractError</code>.
</p>
</div>
<div class="body">
</div>
Expand All @@ -159,7 +174,10 @@ <h1>IntercomError.js</h1>
<a class="pilcrow" href="#section-6" id="section-6">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Expose <code>IntercomError</code>.</p>
<div class="summary">
<p>
Expose <code>IntercomError</code>.
</p>
</div>
<div class="body">
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/doc-filelist.js
@@ -1 +1 @@
var tree={"files":["IntercomError.js","index"]};
var tree={"dirs":{".":{"dirs":{"lib":{"files":["IntercomError.js","intercom.io.js"]}}}}};
8 changes: 8 additions & 0 deletions docs/docco.css
Expand Up @@ -22,3 +22,11 @@
.doc-tag * { color: #222; }
.doc-tag { color: #777; }
.doc-tag * { color: #222; }
.doc-tag { color: #777; }
.doc-tag * { color: #222; }
.doc-tag { color: #777; }
.doc-tag * { color: #222; }
.doc-tag { color: #777; }
.doc-tag * { color: #222; }
.doc-tag { color: #777; }
.doc-tag * { color: #222; }
592 changes: 346 additions & 246 deletions docs/index.html

Large diffs are not rendered by default.

177 changes: 177 additions & 0 deletions docs/lib/IntercomError.js.html
@@ -0,0 +1,177 @@
<!DOCTYPE html>
<html>
<head>
<title>IntercomError.js</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="stylesheet" media="all" href="../doc-style.css" />
<script src="../doc-filelist.js"></script>
<script>
var relativeDir = "../", thisFile = "lib/IntercomError.js", defaultSidebar = false;
</script>
<script src="../doc-script.js"></script>
<script src="../fileSearch.js"></script>
<script src="../goToLine.js"></script>
<link rel="stylesheet" href="../fileSearch.css" />
<link rel="stylesheet" href="../goToLine.css" />
</head>
<body>
<div id="sidebar_wrapper">
<div id="sidebar_switch">
<span class="tree">Files</span>
<span class="headings">Headings</span>
</div>
<div id="tree"></div>
<div id="headings">
</div>
</div>
<div id="sidebar-toggle"></div>
<div id="container"><div class="background highlight"></div>
<table cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="docs">
<h1>IntercomError.js</h1>
</td>
<td class="code highlight"></td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-1" id="section-1">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Module dependencies.</p>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-4" id="line-4">4</a> <span class="kd">var</span> <span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;util&#39;</span><span class="p">);</span>
<a class="line-num" href="#line-5" id="line-5">5</a>
<a class="line-num" href="#line-6" id="line-6">6</a>
<a class="line-num" href="#line-7" id="line-7">7</a> </pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-2" id="section-2">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p><code>AbstractError</code> error.</p>
</div>
<div class="body">
</div>
<div class="details">
<div class="dox_tag_title">API</div>
<div class="dox_tag_detail">
<span class="dox_type">private
</span>
</span>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-11" id="line-11">11</a>
<a class="line-num" href="#line-12" id="line-12">12</a> <span class="kd">function</span> <span class="nx">AbstractError</span><span class="p">(</span><span class="nx">message</span><span class="p">,</span> <span class="nx">constr</span><span class="p">)</span> <span class="p">{</span>
<a class="line-num" href="#line-13" id="line-13">13</a> <span class="nb">Error</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
<a class="line-num" href="#line-14" id="line-14">14</a> <span class="nb">Error</span><span class="p">.</span><span class="nx">captureStackTrace</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">constr</span> <span class="o">||</span> <span class="k">this</span><span class="p">);</span>
<a class="line-num" href="#line-15" id="line-15">15</a>
<a class="line-num" href="#line-16" id="line-16">16</a> <span class="k">this</span><span class="p">.</span><span class="nx">name</span> <span class="o">=</span> <span class="s1">&#39;AbstractError&#39;</span><span class="p">;</span>
<a class="line-num" href="#line-17" id="line-17">17</a> <span class="k">this</span><span class="p">.</span><span class="nx">message</span> <span class="o">=</span> <span class="nx">message</span><span class="p">;</span>
<a class="line-num" href="#line-18" id="line-18">18</a> <span class="p">}</span>
<a class="line-num" href="#line-19" id="line-19">19</a>
<a class="line-num" href="#line-20" id="line-20">20</a>
<a class="line-num" href="#line-21" id="line-21">21</a> </pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-3" id="section-3">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Inherit from <code>Error</code>.</p>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-22" id="line-22">22</a>
<a class="line-num" href="#line-23" id="line-23">23</a> <span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">AbstractError</span><span class="p">,</span> <span class="nb">Error</span><span class="p">);</span>
<a class="line-num" href="#line-24" id="line-24">24</a>
<a class="line-num" href="#line-25" id="line-25">25</a>
<a class="line-num" href="#line-26" id="line-26">26</a> </pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-4" id="section-4">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p><code>IntercomError</code> error.</p>
</div>
<div class="body">
</div>
<div class="details">
<div class="dox_tag_title">API</div>
<div class="dox_tag_detail">
<span class="dox_type">private
</span>
</span>
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-29" id="line-29">29</a>
<a class="line-num" href="#line-30" id="line-30">30</a> <span class="kd">function</span> <span class="nx">IntercomError</span><span class="p">(</span><span class="nx">message</span><span class="p">)</span> <span class="p">{</span>
<a class="line-num" href="#line-31" id="line-31">31</a> <span class="nx">AbstractError</span><span class="p">.</span><span class="nx">apply</span><span class="p">(</span><span class="k">this</span><span class="p">,</span> <span class="nx">arguments</span><span class="p">);</span>
<a class="line-num" href="#line-32" id="line-32">32</a> <span class="k">this</span><span class="p">.</span><span class="nx">name</span> <span class="o">=</span> <span class="s1">&#39;IntercomError&#39;</span><span class="p">;</span>
<a class="line-num" href="#line-33" id="line-33">33</a> <span class="k">this</span><span class="p">.</span><span class="nx">message</span> <span class="o">=</span> <span class="nx">message</span><span class="p">;</span>
<a class="line-num" href="#line-34" id="line-34">34</a> <span class="p">}</span>
<a class="line-num" href="#line-35" id="line-35">35</a>
<a class="line-num" href="#line-36" id="line-36">36</a>
<a class="line-num" href="#line-37" id="line-37">37</a> </pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-5" id="section-5">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Inherit from <code>AbstractError</code>.</p>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-38" id="line-38">38</a>
<a class="line-num" href="#line-39" id="line-39">39</a> <span class="nx">util</span><span class="p">.</span><span class="nx">inherits</span><span class="p">(</span><span class="nx">IntercomError</span><span class="p">,</span> <span class="nx">AbstractError</span><span class="p">);</span>
<a class="line-num" href="#line-40" id="line-40">40</a>
<a class="line-num" href="#line-41" id="line-41">41</a>
<a class="line-num" href="#line-42" id="line-42">42</a>
<a class="line-num" href="#line-43" id="line-43">43</a> </pre></div>
</td>
</tr>
<tr>
<td class="docs">
<div class="pilwrap">
<a class="pilcrow" href="#section-6" id="section-6">&#182;</a>
</div>
<div class="dox">
<div class="summary"><p>Expose <code>IntercomError</code>.</p>
</div>
<div class="body">
</div>
</div>
</td>
<td class="code highlight"><div class="highlight"><pre><a class="line-num" href="#line-44" id="line-44">44</a>
<a class="line-num" href="#line-45" id="line-45">45</a> <span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="nx">IntercomError</span><span class="p">;</span>
<a class="line-num" href="#line-46" id="line-46">46</a> </pre></div>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>

0 comments on commit 208a1ea

Please sign in to comment.