vendor/documentation/javascript/v1/Retreaver.html in retreaverjs-rails-0.2.10 vs vendor/documentation/javascript/v1/Retreaver.html in retreaverjs-rails-0.2.11

- old
+ new

@@ -1,11 +1,11 @@ <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Namespace: Retreaver</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]--> @@ -14,312 +14,335 @@ </head> <body> <div id="main"> - + <h1 class="page-title">Namespace: Retreaver</h1> + - + <section> - + <header> - <h2> - Retreaver - </h2> -</header> + <h2>Retreaver</h2> + + +</header> <article> <div class="container-overview"> - - + - + + <dl class="details"> + - + + + + + + + + + + + - - - - <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="retreaver.js.html">retreaver.js</a>, <a href="retreaver.js.html#line2">line 2</a> </li></ul></dd> + + + - - - </dl> + - </div> + + + - - - - - <h3 class="subsection-title">Classes</h3> - + <dl> <dt><a href="Retreaver.Campaign.html">Campaign</a></dt> <dd></dd> <dt><a href="Retreaver.Number.html">Number</a></dt> <dd></dd> </dl> + + + + + - - - <h3 class="subsection-title">Methods</h3> + - <dl> -<dt> - <h4 class="name" id="configure"><span class="type-signature">&lt;static> </span>configure<span class="signature">(options)</span><span class="type-signature"></span></h4> + + + <h4 class="name" id=".configure"><span class="type-signature">(static) </span>configure<span class="signature">(options)</span><span class="type-signature"></span></h4> + -</dt> -<dd> - - - <div class="description"> - Configure the retreaver client library. - </div> - + + +<div class="description"> + Configure the retreaver client library. +</div> + + + + + + + + + + <h5>Parameters:</h5> - - - - - <h5>Parameters:</h5> - <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>options</code></td> - + <td class="type"> <span class="param-type">Object</span> </td> + + - - - + <td class="description last"> <h6>Properties</h6> <table class="params"> <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + <tr> <td class="name"><code>host</code></td> - + <td class="type"> <span class="param-type">String</span> </td> + + - - - + <td class="description last">Retreaver API Host</td> </tr> - - - + + + <tr> <td class="name"><code>prefix</code></td> - + <td class="type"> <span class="param-type">String</span> </td> + + - - - + <td class="description last">http or https</td> </tr> - - - </tbody> + + + </tbody> </table> + </td> </tr> - - - </tbody> -</table> + - - + </tbody> +</table> + + + + + + <dl class="details"> + - + + + + + + + + + + + - - - - <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="retreaver.js.html">retreaver.js</a>, <a href="retreaver.js.html#line7">line 7</a> </li></ul></dd> + + + - - - </dl> - - - + + + + + + + + + + + + + <h5>Example</h5> - - - - - - - <h5>Example</h5> - <pre class="prettyprint"><code>Retreaver.configure({host: 'api.rtvrapi.com', prefix: 'https'});</code></pre> + + + -</dd> - </dl> + - - - </article> -</section> +</section> </div> <nav> - <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Retreaver.Campaign.html">Campaign</a></li><li><a href="Retreaver.Number.html">Number</a></li></ul><h3>Namespaces</h3><ul><li><a href="Retreaver.html">Retreaver</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> -<br clear="both"> +<br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Thu Oct 27 2016 22:04:38 GMT-0400 (EDT) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Feb 16 2017 17:35:24 GMT-0500 (EST) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> \ No newline at end of file