MyApi.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>MyApi</title>
  7. <!--[if lt IE 9]>
  8. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  9. <![endif]-->
  10. <link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
  11. <link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
  12. <link type="text/css" rel="stylesheet" href="css/prism.min.css">
  13. <link type="text/css" rel="stylesheet" href="css/template.min.css">
  14. <script type="text/javascript">
  15. window.TEMPLATE_OPTIONS = {"includeDate":true,"dateFormat":"Do MMM YYYY","systemName":"FooDoc","systemSummary":"A Bootstrap and Handlebars based template for JSDoc3.","systemLogo":"","systemColor":"","navMembers":[{"kind":"class","title":"Classes","summary":"All documented classes."},{"kind":"external","title":"Externals","summary":"All documented external members."},{"kind":"global","title":"Globals","summary":"All documented globals."},{"kind":"mixin","title":"Mixins","summary":"All documented mixins."},{"kind":"interface","title":"Interfaces","summary":"All documented interfaces."},{"kind":"module","title":"Modules","summary":"All documented modules."},{"kind":"namespace","title":"Namespaces","summary":"All documented namespaces."},{"kind":"tutorial","title":"Tutorials","summary":"All available tutorials."}],"footer":"","copyright":"FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.","linenums":true,"collapseSymbols":true,"inverseNav":true,"inlineNav":false,"outputSourceFiles":true,"sourceRootPath":null,"disablePackagePath":true,"outputSourcePath":false,"showTableOfContents":true,"showAccessFilter":true,"analytics":null,"methodHeadingReturns":true,"sort":"linenum, longname, version, since","search":true,"favicon":null,"stylesheets":[],"scripts":[],"monospaceLinks":false,"cleverLinks":false};
  16. window.DOCLET_TOC_ENABLED = true;
  17. window.DOCLET_AFILTER_ENABLED = false;
  18. </script>
  19. </head>
  20. <body>
  21. <!-- start:navbar.hbs -->
  22. <header class="navbar navbar-default navbar-fixed-top navbar-inverse">
  23. <div class="container">
  24. <div class="navbar-header">
  25. <a class="navbar-brand" href="index.html">
  26. FooDoc
  27. </a>
  28. <!-- displayed on small devices -->
  29. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. </div>
  35. <div class="navbar-collapse collapse" id="topNavigation">
  36. <ul class="nav navbar-nav">
  37. <li class="dropdown">
  38. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
  39. <ul class="dropdown-menu">
  40. <li><a href="global.html#SomeType">SomeType</a></li>
  41. </ul>
  42. </li>
  43. <li class="dropdown">
  44. <a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  45. <ul class="dropdown-menu">
  46. <li><a href="CustomError.html">CustomError</a></li>
  47. <li><a href="GlobalClass.html">GlobalClass</a></li>
  48. <li><a href="MyApi.Child.html">MyApi.Child</a></li>
  49. <li><a href="MyApi.Class.html">MyApi.Class</a></li>
  50. </ul>
  51. </li>
  52. <li class="dropdown">
  53. <a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  54. <ul class="dropdown-menu">
  55. <li><a href="MyApi.html">MyApi</a></li>
  56. <li><a href="MyApi.utils.html">MyApi.utils</a></li>
  57. </ul>
  58. </li>
  59. <li class="dropdown">
  60. <a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
  61. <ul class="dropdown-menu">
  62. <li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
  63. <li><a href="tutorial-drive-car.html">Drive Car</a></li>
  64. </ul>
  65. </li>
  66. </ul>
  67. <!-- start:lunr-search-navbar.hbs -->
  68. <form class="navbar-form navbar-right" role="search">
  69. <div class="input-group">
  70. <input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
  71. <div class="input-group-btn">
  72. <button class="btn btn-default" id="lunr-search-submit">
  73. <i class="glyphicon glyphicon-search"></i>
  74. </button>
  75. </div>
  76. </div>
  77. </form>
  78. <!-- start:lunr-search-navbar.hbs --> </div>
  79. </div>
  80. </header>
  81. <!-- end:navbar.hbs --> <div class="page-header">
  82. <div class="container">
  83. <span class="kind">namespace</span>
  84. <h1><span class="name">MyApi</span></h1>
  85. <div class="summary"><p>This is the test summary for the <code>MyApi</code> namespace.</p></div> </div>
  86. </div>
  87. <div class="container content">
  88. <div class="row">
  89. <div class="col-md-9 main-content">
  90. <ol class="breadcrumb">
  91. <li><a href="index.html">Home</a></li>
  92. <li><a href="list_namespace.html">Namespaces</a></li>
  93. <li class="active">MyApi</li>
  94. </ol>
  95. <section>
  96. <dl class="symbol primary">
  97. <dt class="symbol-title namespace collapsible-symbol expanded">
  98. <h2 class="namespace"><span class="name">MyApi</span></h2>
  99. <div class="summary"><p>This is the test summary for the <code>MyApi</code> namespace.</p></div></dt>
  100. <dd class="symbol-details namespace collapsible-symbol expanded" style="max-height: 9999px;">
  101. <div class="symbol-details-inner">
  102. <div class="callout callout-primary"><h5>Description</h5> <div class="description"><p>This is the longer description for the namespace giving a better idea about the code contained within it.</p></div>
  103. </div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  104. <!-- source -->
  105. <div class="form-group">
  106. <label class="col-sm-3 control-label">Source</label>
  107. <div class="col-sm-9">
  108. <p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-1">line 1</a></p>
  109. </div>
  110. </div>
  111. </form>
  112. </div> </div>
  113. </dd>
  114. </dl>
  115. <article class="secondary">
  116. <h3>Classes</h3>
  117. <dl class="symbol">
  118. <hr/>
  119. <dt class="symbol-title class public">
  120. <h4 id="Class" class="class public"><a href="MyApi.Class.html"><span class="signature-new">new&nbsp;</span><span class="name">Class</span><span class="signature-params">( <span class="signature-param">arg1</span> [,&nbsp;<span class="signature-param">...arg2</span>&nbsp;]&nbsp;)</span><span class="signature-type"></span></a></h4>
  121. <div class="summary"><p>This is the summary of the MyApi test class, test <code>markdown</code>.</p></div></dt>
  122. <dd class="symbol-details class public">
  123. <div class="symbol-details-inner">
  124. </div>
  125. </dd>
  126. <hr/>
  127. <dt class="symbol-title class public">
  128. <h4 id="Child" class="class public"><a href="MyApi.Child.html"><span class="signature-new">new&nbsp;</span><span class="name">Child</span><span class="signature-params">()</span><span class="signature-type"></span></a></h4>
  129. <div class="summary"><p>This is the summary of the MyApi child class, test <code>markdown</code>.</p></div></dt>
  130. <dd class="symbol-details class public">
  131. <div class="symbol-details-inner">
  132. </div>
  133. </dd>
  134. </dl>
  135. <h3>Namespaces</h3>
  136. <dl class="symbol">
  137. <hr/>
  138. <dt class="symbol-title namespace public">
  139. <h4 id="utils" class="namespace public"><a href="MyApi.utils.html"><span class="name">utils</span></a></h4>
  140. <div class="summary"><p>This is to test child namespaces.</p></div></dt>
  141. <dd class="symbol-details namespace public">
  142. <div class="symbol-details-inner">
  143. </div>
  144. </dd>
  145. </dl>
  146. <h3>Members</h3>
  147. <dl class="symbol">
  148. <hr/>
  149. <dt class="symbol-title member public collapsible-symbol">
  150. <h4 id=".staticMember" class="member public"><span class="signature-attribs">&lt;static> </span><span class="name">staticMember</span><span class="signature-type"> :string</span></h4>
  151. <div class="summary"><p>This is a static member of the namespace.</p></div></dt>
  152. <dd class="symbol-details member public collapsible-symbol">
  153. <div class="symbol-details-inner">
  154. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  155. <!-- type -->
  156. <div class="form-group">
  157. <label class="col-sm-3 control-label">Type</label>
  158. <div class="col-sm-9">
  159. <div class="form-control-static type-names"><span class="param-type">string</span></div>
  160. </div>
  161. </div>
  162. <!-- defaultvalue -->
  163. <div class="form-group">
  164. <label class="col-sm-3 control-label">Default Value</label>
  165. <div class="col-sm-9">
  166. <p class="form-control-static">I&#x27;m a member of the MyApi namespace.</p>
  167. </div>
  168. </div>
  169. <!-- source -->
  170. <div class="form-group">
  171. <label class="col-sm-3 control-label">Source</label>
  172. <div class="col-sm-9">
  173. <p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-7">line 7</a></p>
  174. </div>
  175. </div>
  176. </form>
  177. </div> </div>
  178. </dd>
  179. </dl>
  180. <h3>Type Definitions</h3>
  181. <dl class="symbol">
  182. <hr/>
  183. <dt class="symbol-title typedef public collapsible-symbol">
  184. <h4 id="~Object" class="typedef public"><span class="name">Object</span></h4>
  185. <div class="summary"><p>This is a test type definition on the MyApi namespace.</p></div></dt>
  186. <dd class="symbol-details typedef public collapsible-symbol">
  187. <div class="symbol-details-inner">
  188. <div class="callout callout-info">
  189. <h5>Properties</h5>
  190. <table class="params table table-striped">
  191. <thead>
  192. <tr>
  193. <th>Name</th>
  194. <th>Type</th>
  195. <th>Attributes</th>
  196. <th>Default</th>
  197. <th class="last">Description</th>
  198. </tr>
  199. </thead>
  200. <tbody>
  201. <tr>
  202. <td><code>name</code></td>
  203. <td><span class="param-type">string</span></td>
  204. <td class="attributes"></td>
  205. <td></td>
  206. <td class="last">
  207. <p>This is the name of the test object.</p>
  208. </td>
  209. </tr>
  210. <tr>
  211. <td><code>enabled</code></td>
  212. <td><span class="param-type">boolean</span></td>
  213. <td class="attributes">&lt;optional&gt;<br/></td>
  214. <td>false</td>
  215. <td class="last">
  216. <p>This is whether or not the test object is enabled. Defaults to <code>false</code>.</p>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. </div>
  222. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  223. <!-- type -->
  224. <div class="form-group">
  225. <label class="col-sm-3 control-label">Type</label>
  226. <div class="col-sm-9">
  227. <div class="form-control-static type-names"><span class="param-type">Object</span></div>
  228. </div>
  229. </div>
  230. <!-- source -->
  231. <div class="form-group">
  232. <label class="col-sm-3 control-label">Source</label>
  233. <div class="col-sm-9">
  234. <p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-17">line 17</a></p>
  235. </div>
  236. </div>
  237. </form>
  238. </div> </div>
  239. </dd>
  240. </dl>
  241. </article>
  242. </section>
  243. </div>
  244. <div class="col-md-3 side-content">
  245. <nav class="toc hidden-print hidden-sm hidden-xs"></nav>
  246. </div>
  247. </div>
  248. </div>
  249. <footer>
  250. <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
  251. <div class="generated-by">Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on 1st May 2018 using the <a href="https://github.com/steveush/foodoc">FooDoc template</a>.</div>
  252. </footer>
  253. <script src="js/jquery.min.js"></script>
  254. <script src="js/bootstrap.min.js"></script>
  255. <script src="js/clipboard.min.js"></script>
  256. <script src="js/prism.min.js"></script>
  257. <script src="js/template.min.js"></script>
  258. <!-- start:lunr-search-modal.hbs -->
  259. <div class="modal fade" id="lunr-search-modal">
  260. <div class="modal-dialog">
  261. <div class="modal-content">
  262. <div class="modal-header">
  263. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  264. <h4 class="modal-title">Search results</h4>
  265. </div>
  266. <div class="modal-body" id="lunr-search-body">
  267. </div>
  268. <div class="modal-footer" id="lunr-search-footer">
  269. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  270. </div>
  271. </div><!-- /.modal-content -->
  272. </div><!-- /.modal-dialog -->
  273. </div>
  274. <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
  275. </body>
  276. </html>