Skip to content
This repository has been archived by the owner on May 24, 2022. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@miguelmota
miguelmota committed May 22, 2017
1 parent 38f71c1 commit c212866
Show file tree
Hide file tree
Showing 32 changed files with 29,501 additions and 188 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A gray and blue [JSDoc](http://usejsdoc.org/) template theme (based off [docstra

# Demo

**[http://jsdoc-oblivion.moogs.io](http://jsdoc-oblivion.moogs.io)**
**[https://lab.miguelmota.com/jsdoc-oblivion](https://lab.miguelmota.com/jsdoc-oblivion)**

# Install

Expand Down
2 changes: 1 addition & 1 deletion bower.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jsdoc-oblivion",
"version": "0.0.4",
"version": "0.0.5",
"homepage": "https://github.com/miguelmota/jsdoc-oblivion",
"authors": [
"Miguel Mota <miguelmota2@gmail.com>"
Expand Down
70 changes: 35 additions & 35 deletions docs/base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,43 +32,43 @@
</li>

<li>
<a href="chains_.html">base/chains</a>
<a href="module-base_chains.html">base/chains</a>
</li>

<li>
<a href="binder.html">documents/binder</a>
<a href="module-documents_binder.html">documents/binder</a>
</li>

<li>
<a href="model_.html">documents/model</a>
<a href="module-documents_model.html">documents/model</a>
</li>

<li>
<a href="probe.html">documents/probe</a>
<a href="module-documents_probe.html">documents/probe</a>
</li>

<li>
<a href="schema_.html">documents/schema</a>
<a href="module-documents_schema.html">documents/schema</a>
</li>

<li>
<a href="collector.html">ink/collector</a>
<a href="module-ink_collector.html">ink/collector</a>
</li>

<li>
<a href="bussable_.html">mixins/bussable</a>
<a href="module-mixins_bussable.html">mixins/bussable</a>
</li>

<li>
<a href="signalable_.html">mixins/signalable</a>
<a href="module-mixins_signalable.html">mixins/signalable</a>
</li>

<li>
<a href="format.html">strings/format</a>
<a href="module-strings_format.html">strings/format</a>
</li>

<li>
<a href="logger.html">utils/logger</a>
<a href="module-utils_logger.html">utils/logger</a>
</li>


Expand All @@ -86,39 +86,39 @@
</li>

<li>
<a href="chains.html">base/chains</a>
<a href="base_chains.html">base/chains</a>
</li>

<li>
<a href="model.html">documents/model</a>
<a href="documents_model.html">documents/model</a>
</li>

<li>
<a href="probe.queryOperators.html">documents/probe.queryOperators</a>
<a href="module-documents_probe.queryOperators.html">documents/probe.queryOperators</a>
</li>

<li>
<a href="probe.updateOperators.html">documents/probe.updateOperators</a>
<a href="module-documents_probe.updateOperators.html">documents/probe.updateOperators</a>
</li>

<li>
<a href="collector-ACollector.html">ink/collector~ACollector</a>
<a href="module-ink_collector-ACollector.html">ink/collector~ACollector</a>
</li>

<li>
<a href="collector-CollectorBase_.html">ink/collector~CollectorBase</a>
<a href="module-ink_collector-CollectorBase.html">ink/collector~CollectorBase</a>
</li>

<li>
<a href="collector-OCollector.html">ink/collector~OCollector</a>
<a href="module-ink_collector-OCollector.html">ink/collector~OCollector</a>
</li>

<li>
<a href="signalable-Signal.html">mixins/signalable~Signal</a>
<a href="module-mixins_signalable-Signal.html">mixins/signalable~Signal</a>
</li>

<li>
<a href="logger.Logger.html">utils/logger.Logger</a>
<a href="utils_logger.Logger.html">utils/logger.Logger</a>
</li>


Expand All @@ -132,15 +132,15 @@
<ul class="dropdown-menu ">

<li>
<a href="schema.html">documents/schema</a>
<a href="documents_schema.html">documents/schema</a>
</li>

<li>
<a href="bussable.html">mixins/bussable</a>
<a href="mixins_bussable.html">mixins/bussable</a>
</li>

<li>
<a href="signalable.html">mixins/signalable</a>
<a href="mixins_signalable.html">mixins/signalable</a>
</li>


Expand Down Expand Up @@ -254,7 +254,7 @@ <h4 class="name" id="base"><span class="type-signature"></span>new base<span cla
<h3 class="subsection-title">Extends</h3>

<ul>
<li><a href="chains.html">base/chains</a></li>
<li><a href="base_chains.html">base/chains</a></li>
</ul>


Expand All @@ -280,7 +280,7 @@ <h4><span class="type-signature"></span>close<span class="type-signature"></span

<div class="description">
The `close` method asks an object to shut itself down in a way that will allow it to be reopened, unlike the
<a href="chains.html#end">end method</a> which will call the destroy method which should make the object unusable, but also
<a href="base_chains.html#end">end method</a> which will call the destroy method which should make the object unusable, but also
devoid of all resources whereas `close` may still keep some resources open.

This uses the `before` chain which means the last one defined in the first one destroyed
Expand All @@ -302,7 +302,7 @@ <h4><span class="type-signature"></span>close<span class="type-signature"></span
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="chains.html#close">base/chains#close</a>
<a href="base_chains.html#close">base/chains#close</a>
</li>
</ul>
</dd>
Expand All @@ -328,7 +328,7 @@ <h4><span class="type-signature"></span>close<span class="type-signature"></span
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="chains.html#open">base/chains#open</a></li>
<li><a href="base_chains.html#open">base/chains#open</a></li>
</ul>
</dd>

Expand All @@ -350,7 +350,7 @@ <h4><span class="type-signature"></span>open<span class="type-signature"></span>
<dd>

<div class="description">
If you are using the open/close paradigm for an object that can kind of go dormant on <a href="chains.html#close">base/chains#close</a> and can be "reopened"
If you are using the open/close paradigm for an object that can kind of go dormant on <a href="base_chains.html#close">base/chains#close</a> and can be "reopened"
again later, here is where the "open" code will go.

This used the `after` chain which means that the first one defined is the first one destroyed.
Expand All @@ -372,7 +372,7 @@ <h4><span class="type-signature"></span>open<span class="type-signature"></span>
<dd class="inherited-from">
<ul class="dummy">
<li>
<a href="chains.html#open">base/chains#open</a>
<a href="base_chains.html#open">base/chains#open</a>
</li>
</ul>
</dd>
Expand All @@ -398,7 +398,7 @@ <h4><span class="type-signature"></span>open<span class="type-signature"></span>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="chains.html#close">base/chains#close</a></li>
<li><a href="base_chains.html#close">base/chains#close</a></li>
</ul>
</dd>

Expand Down Expand Up @@ -716,9 +716,9 @@ <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span c
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>{<a href="chains.html#end">base/chains#end</a>}</li>
<li>{<a href="base_chains.html#end">base/chains#end</a>}</li>

<li>{<a href="chains.html#destroy">base/chains#destroy</a>}</li>
<li>{<a href="base_chains.html#destroy">base/chains#destroy</a>}</li>
</ul>
</dd>

Expand Down Expand Up @@ -793,9 +793,9 @@ <h4 class="name" id="end"><span class="type-signature"></span>end<span class="si
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li>{<a href="chains.html#end">base/chains#end</a>}</li>
<li>{<a href="base_chains.html#end">base/chains#end</a>}</li>

<li>{<a href="chains.html#destroy">base/chains#destroy</a>}</li>
<li>{<a href="base_chains.html#destroy">base/chains#destroy</a>}</li>
</ul>
</dd>

Expand Down Expand Up @@ -842,8 +842,8 @@ <h4 class="name" id="end"><span class="type-signature"></span>end<span class="si
<br />

<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc" target="_blank">JSDoc 3.3.0-alpha9</a>
on 2014-09-07T09:05:22-07:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc" target="_blank">JSDoc 3.4.3</a>
on 2017-05-21T20:58:03-07:00
</span>
</footer>
</div>
Expand Down
Loading

0 comments on commit c212866

Please sign in to comment.