Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
muhammaddadu committed Feb 7, 2018
1 parent 45765b0 commit d099e67
Show file tree
Hide file tree
Showing 36 changed files with 3,257 additions and 192 deletions.
160 changes: 4 additions & 156 deletions docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,72 +94,6 @@ <h2></h2>



<h3 class="subsection-title">Members</h3>



<h4 class="name" id="CORE_PRIORITY"><span class="type-signature">(constant) </span>CORE_PRIORITY<span class="type-signature"></span></h4>




<div class="description">
Priority for core hooks
</div>







<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_Clout.js.html">lib/Clout.js</a>, <a href="lib_Clout.js.html#line22">line 22</a>
</li></ul></dd>







</dl>










<h3 class="subsection-title">Methods</h3>
Expand Down Expand Up @@ -271,7 +205,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="hooks_apis.js.html">hooks/apis.js</a>, <a href="hooks_apis.js.html#line21">line 21</a>
<a href="hooks_apis.js.html">hooks/apis.js</a>, <a href="hooks_apis.js.html#line22">line 22</a>
</li></ul></dd>


Expand Down Expand Up @@ -406,93 +340,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="hooks_apis.js.html">hooks/apis.js</a>, <a href="hooks_apis.js.html#line86">line 86</a>
</li></ul></dd>







</dl>
























<h4 class="name" id="Logger"><span class="type-signature"></span>Logger<span class="signature">()</span><span class="type-signature"></span></h4>






<div class="description">
Clout Logger (Extends winston)
</div>













<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_logger.js.html">lib/logger.js</a>, <a href="lib_logger.js.html#line16">line 16</a>
<a href="hooks_apis.js.html">hooks/apis.js</a>, <a href="hooks_apis.js.html#line87">line 87</a>
</li></ul></dd>


Expand Down Expand Up @@ -536,13 +384,13 @@ <h4 class="name" id="Logger"><span class="type-signature"></span>Logger<span cla
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Clout.html">Clout</a></li><li><a href="Config.html">Config</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CORE_PRIORITY">CORE_PRIORITY</a></li><li><a href="global.html#loadAPI">loadAPI</a></li><li><a href="global.html#loadAPIsFromDirectory">loadAPIsFromDirectory</a></li><li><a href="global.html#Logger">Logger</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-clout-js_hooks_config.html">clout-js/hooks/config</a></li><li><a href="module-clout-js_hooks_controllers.html">clout-js/hooks/controllers</a></li><li><a href="module-clout-js_hooks_engines.html">clout-js/hooks/engines</a></li><li><a href="module-clout-js_hooks_middleware.html">clout-js/hooks/middleware</a></li><li><a href="module-clout-js_hooks_models.html">clout-js/hooks/models</a></li><li><a href="module-clout-js_hooks_server.html">clout-js/hooks/server</a></li><li><a href="module-clout-js_lib_Clout.html">clout-js/lib/Clout</a></li><li><a href="module-clout-js_lib_Config.html">clout-js/lib/Config</a></li><li><a href="module-clout-js_lib_Logger.html">clout-js/lib/Logger</a></li><li><a href="module-clout-js_lib_utils.html">clout-js/lib/utils</a></li></ul><h3>Classes</h3><ul><li><a href="module-clout-js_lib_Clout-Clout.html">Clout</a></li><li><a href="module-clout-js_lib_Config-Config.html">Config</a></li></ul><h3>Global</h3><ul><li><a href="global.html#loadAPI">loadAPI</a></li><li><a href="global.html#loadAPIsFromDirectory">loadAPIsFromDirectory</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 07 2018 23:16:18 GMT+0000 (GMT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 07 2018 23:43:39 GMT+0000 (GMT)
</footer>

<script> prettyPrint(); </script>
Expand Down
5 changes: 3 additions & 2 deletions docs/hooks_apis.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ <h1 class="page-title">Source: hooks/apis.js</h1>
* clout-js
* Copyright(c) 2015 - 2016 Muhammad Dadu
* MIT Licensed
* @module clout-js/hooks/apis
*/
const debug = require('debug')('clout:hook/apis');
const path = require('path');
Expand Down Expand Up @@ -145,13 +146,13 @@ <h1 class="page-title">Source: hooks/apis.js</h1>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Clout.html">Clout</a></li><li><a href="Config.html">Config</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CORE_PRIORITY">CORE_PRIORITY</a></li><li><a href="global.html#loadAPI">loadAPI</a></li><li><a href="global.html#loadAPIsFromDirectory">loadAPIsFromDirectory</a></li><li><a href="global.html#Logger">Logger</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-clout-js_hooks_config.html">clout-js/hooks/config</a></li><li><a href="module-clout-js_hooks_controllers.html">clout-js/hooks/controllers</a></li><li><a href="module-clout-js_hooks_engines.html">clout-js/hooks/engines</a></li><li><a href="module-clout-js_hooks_middleware.html">clout-js/hooks/middleware</a></li><li><a href="module-clout-js_hooks_models.html">clout-js/hooks/models</a></li><li><a href="module-clout-js_hooks_server.html">clout-js/hooks/server</a></li><li><a href="module-clout-js_lib_Clout.html">clout-js/lib/Clout</a></li><li><a href="module-clout-js_lib_Config.html">clout-js/lib/Config</a></li><li><a href="module-clout-js_lib_Logger.html">clout-js/lib/Logger</a></li><li><a href="module-clout-js_lib_utils.html">clout-js/lib/utils</a></li></ul><h3>Classes</h3><ul><li><a href="module-clout-js_lib_Clout-Clout.html">Clout</a></li><li><a href="module-clout-js_lib_Config-Config.html">Config</a></li></ul><h3>Global</h3><ul><li><a href="global.html#loadAPI">loadAPI</a></li><li><a href="global.html#loadAPIsFromDirectory">loadAPIsFromDirectory</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 07 2018 23:16:18 GMT+0000 (GMT)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 07 2018 23:43:39 GMT+0000 (GMT)
</footer>

<script> prettyPrint(); </script>
Expand Down
74 changes: 74 additions & 0 deletions docs/hooks_config.js.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: hooks/config.js</title>

<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

<h1 class="page-title">Source: hooks/config.js</h1>






<section>
<article>
<pre class="prettyprint source linenums"><code>/*!
* clout-js
* Copyright(c) 2015 - 2016 Muhammad Dadu
* MIT Licensed
*/
/**
* Config hooks
* @module clout-js/hooks/config
*/
const debug = require('debug')('clout:hook/config');

module.exports = {
middleware: {
event: 'start',
priority: 25,
fn: function (next) {
!this.app.locals &amp;&amp; (this.app.locals = {});
this.app.locals.config = this.config;
this.app.request.clout = this;
next();
}
}
};
</code></pre>
</article>
</section>




</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-clout-js_hooks_config.html">clout-js/hooks/config</a></li><li><a href="module-clout-js_hooks_controllers.html">clout-js/hooks/controllers</a></li><li><a href="module-clout-js_hooks_engines.html">clout-js/hooks/engines</a></li><li><a href="module-clout-js_hooks_middleware.html">clout-js/hooks/middleware</a></li><li><a href="module-clout-js_hooks_models.html">clout-js/hooks/models</a></li><li><a href="module-clout-js_hooks_server.html">clout-js/hooks/server</a></li><li><a href="module-clout-js_lib_Clout.html">clout-js/lib/Clout</a></li><li><a href="module-clout-js_lib_Config.html">clout-js/lib/Config</a></li><li><a href="module-clout-js_lib_Logger.html">clout-js/lib/Logger</a></li><li><a href="module-clout-js_lib_utils.html">clout-js/lib/utils</a></li></ul><h3>Classes</h3><ul><li><a href="module-clout-js_lib_Clout-Clout.html">Clout</a></li><li><a href="module-clout-js_lib_Config-Config.html">Config</a></li></ul><h3>Global</h3><ul><li><a href="global.html#loadAPI">loadAPI</a></li><li><a href="global.html#loadAPIsFromDirectory">loadAPIsFromDirectory</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 07 2018 23:43:39 GMT+0000 (GMT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Loading

0 comments on commit d099e67

Please sign in to comment.