comments and docs, closes #19

bionode · Feb 14, 2016 · 7df18a7 · 7df18a7
1 parent 18988e3
commit 7df18a7
Show file tree

Hide file tree

Showing 10 changed files with 575 additions and 112 deletions.
diff --git a/README.md b/README.md
@@ -1,21 +1,10 @@
 # bionode-obo
 
-Parse OBO files, in a stream!
+Parse OBO files, with streams!
 
 ## API Documentation
 
-See [here](https://rawgit.com/thejmazz/bionode-obo/master/docs/module-bionode-obo.html)
-or below.
-
-A small wrapper around custom event emitters.
-
-<a name="exp_module_emitter--module.exports"></a>
-### module.exports() ⇒ <code>object</code> ⏏
-Return a new custom event emitter
-
-**Kind**: Exported function  
-**Returns**: <code>object</code> - a function inheriting from EventEmitter with a default
-                 `#write()` method  
+See [here](https://rawgit.com/thejmazz/bionode-obo/master/docs/module-bionode-obo.html).
 
 ## License
 

diff --git a/docs/README.hbs b/docs/README.hbs
@@ -1,18 +1,10 @@
 # bionode-obo
 
-Parse OBO files.
+Parse OBO files, with streams!
 
 ## API Documentation
 
-See [here](https://rawgit.com/thejmazz/bionode-obo/master/docs/module-bionode-obo.html)
-or below.
-
-{{#module}}
-{{>body~}}
-{{>member-index~}}
-{{>separator~}}
-{{>members~}}
-{{/module}}
+See [here](https://rawgit.com/thejmazz/bionode-obo/master/docs/module-bionode-obo.html).
 
 ## License
 

diff --git a/docs/emitter.js.html b/docs/emitter.js.html
@@ -71,7 +71,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Dec 20 2015 16:18:59 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Feb 14 2016 13:27:00 GMT-0500 (EST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bi
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Dec 20 2015 16:18:59 GMT-0500 (EST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Feb 14 2016 13:27:00 GMT-0500 (EST)
 </footer>
 
 <script> prettyPrint(); </script>