global.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>Globals</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">global</span>
  84. <h1><span class="name">Globals</span></h1>
  85. <div class="summary"><p>All documented globals.</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 class="active">Globals</li>
  93. </ol>
  94. <section>
  95. <article class="secondary">
  96. <h3>Type Definitions</h3>
  97. <dl class="symbol">
  98. <hr/>
  99. <dt class="symbol-title typedef public collapsible-symbol">
  100. <h4 id="SomeType" class="typedef public"><span class="name">SomeType</span></h4>
  101. </dt>
  102. <dd class="symbol-details typedef public collapsible-symbol">
  103. <div class="symbol-details-inner">
  104. <div class="callout callout-primary"><h5>Description</h5> <div class="description"><p>Some global type.</p></div>
  105. </div> <div class="callout callout-info">
  106. <h5>Properties</h5>
  107. <table class="params table table-striped">
  108. <thead>
  109. <tr>
  110. <th>Name</th>
  111. <th>Type</th>
  112. <th class="last">Description</th>
  113. </tr>
  114. </thead>
  115. <tbody>
  116. <tr>
  117. <td><code>someProp</code></td>
  118. <td><span class="param-type">string</span></td>
  119. <td class="last">
  120. </td>
  121. </tr>
  122. </tbody>
  123. </table>
  124. </div>
  125. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  126. <!-- type -->
  127. <div class="form-group">
  128. <label class="col-sm-3 control-label">Type</label>
  129. <div class="col-sm-9">
  130. <div class="form-control-static type-names"><span class="param-type">Object</span></div>
  131. </div>
  132. </div>
  133. <!-- source -->
  134. <div class="form-group">
  135. <label class="col-sm-3 control-label">Source</label>
  136. <div class="col-sm-9">
  137. <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-64">line 64</a></p>
  138. </div>
  139. </div>
  140. </form>
  141. </div> </div>
  142. </dd>
  143. </dl>
  144. </article>
  145. </section>
  146. </div>
  147. <div class="col-md-3 side-content">
  148. <nav class="toc hidden-print hidden-sm hidden-xs"></nav>
  149. </div>
  150. </div>
  151. </div>
  152. <footer>
  153. <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
  154. <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>
  155. </footer>
  156. <script src="js/jquery.min.js"></script>
  157. <script src="js/bootstrap.min.js"></script>
  158. <script src="js/clipboard.min.js"></script>
  159. <script src="js/prism.min.js"></script>
  160. <script src="js/template.min.js"></script>
  161. <!-- start:lunr-search-modal.hbs -->
  162. <div class="modal fade" id="lunr-search-modal">
  163. <div class="modal-dialog">
  164. <div class="modal-content">
  165. <div class="modal-header">
  166. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  167. <h4 class="modal-title">Search results</h4>
  168. </div>
  169. <div class="modal-body" id="lunr-search-body">
  170. </div>
  171. <div class="modal-footer" id="lunr-search-footer">
  172. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  173. </div>
  174. </div><!-- /.modal-content -->
  175. </div><!-- /.modal-dialog -->
  176. </div>
  177. <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
  178. </body>
  179. </html>