GlobalClass.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>GlobalClass</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 = true;
  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">class</span>
  84. <h1><span class="name">GlobalClass</span></h1>
  85. <div class="summary"><p>This is the summary of the global test class, test <code>markdown</code>.</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_class.html">Classes</a></li>
  93. <li class="active">GlobalClass</li>
  94. </ol>
  95. <div class="access-filter">
  96. <label class="checkbox-inline">
  97. <input class="toggle-public" type="checkbox" value="" checked>
  98. Public
  99. </label>
  100. <label class="checkbox-inline">
  101. <input class="toggle-private" type="checkbox" value="" checked>
  102. Private
  103. </label>
  104. </div>
  105. <section>
  106. <dl class="symbol primary">
  107. <dt class="symbol-title class collapsible-symbol expanded">
  108. <h2 class="class"><span class="signature-new">new&nbsp;</span><span class="name">GlobalClass</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></h2>
  109. <div class="summary"><p>This is the summary of the global test class, test <code>markdown</code>.</p></div></dt>
  110. <dd class="symbol-details class collapsible-symbol expanded" style="max-height: 9999px;">
  111. <div class="symbol-details-inner">
  112. <div class="callout callout-primary"><h5>Description</h5> <div class="description"><p>This is the description for the class this is meant to be a more in depth explanation of what this class does and it's general use case, test <code>markdown</code></p></div>
  113. </div> <div class="callout callout-info">
  114. <h5>Parameters</h5>
  115. <table class="params table table-striped">
  116. <thead>
  117. <tr>
  118. <th>Name</th>
  119. <th>Type</th>
  120. <th>Attributes</th>
  121. <th>Default</th>
  122. <th class="last">Description</th>
  123. </tr>
  124. </thead>
  125. <tbody>
  126. <tr>
  127. <td><code>arg1</code></td>
  128. <td><span class="param-type">string</span></td>
  129. <td class="attributes"></td>
  130. <td></td>
  131. <td class="last">
  132. <p>The first test arg, test <code>markdown</code>.</p>
  133. </td>
  134. </tr>
  135. <tr>
  136. <td><code>arg2</code></td>
  137. <td><span class="param-type">string</span></td>
  138. <td class="attributes">&lt;optional&gt;<br/>&lt;repeatable&gt;<br/></td>
  139. <td>false</td>
  140. <td class="last">
  141. <p>A repeatable, optional argument with a default value of false, test <code>markdown</code>.</p>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. </div>
  147. <div class="callout callout-example"><h5>Examples</h5> <div class="example-caption"><p>You can provide example captions with <code>markdown</code> and specify the language to use when rendering the code, defaults to <code>javascript</code>.</p></div>
  148. <div class="example-code">
  149. <pre class="prettyprint source language-javascript"><code class="language-javascript"> var gc &#x3D; new GlobalClass(&quot;arg1&quot;, &quot;arg2&quot;);</code></pre>
  150. </div>
  151. <div class="example-code">
  152. <pre class="prettyprint source language-xml"><code class="language-xml"> &lt;head&gt; &lt;title&gt;HTML Highlighting&lt;/title&gt; &lt;script&gt; // supports embedded languages var gc &#x3D; new GlobalClass(&quot;arg1&quot;, &quot;arg2&quot;); &lt;/script&gt; &lt;/head&gt;</code></pre>
  153. </div>
  154. </div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  155. <!-- source -->
  156. <div class="form-group">
  157. <label class="col-sm-3 control-label">Source</label>
  158. <div class="col-sm-9">
  159. <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-1">line 1</a></p>
  160. </div>
  161. </div>
  162. </form>
  163. </div> </div>
  164. </dd>
  165. </dl>
  166. <article class="secondary">
  167. <h3>Members</h3>
  168. <dl class="symbol">
  169. <hr/>
  170. <dt class="symbol-title member public collapsible-symbol">
  171. <h4 id="name" class="member public"><span class="name">name</span><span class="signature-type"> :string</span></h4>
  172. <div class="summary"><p>The name of the class.</p></div></dt>
  173. <dd class="symbol-details member public collapsible-symbol">
  174. <div class="symbol-details-inner">
  175. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  176. <!-- type -->
  177. <div class="form-group">
  178. <label class="col-sm-3 control-label">Type</label>
  179. <div class="col-sm-9">
  180. <div class="form-control-static type-names"><span class="param-type">string</span></div>
  181. </div>
  182. </div>
  183. <!-- defaultvalue -->
  184. <div class="form-group">
  185. <label class="col-sm-3 control-label">Default Value</label>
  186. <div class="col-sm-9">
  187. <p class="form-control-static">&quot;Test Global&quot;</p>
  188. </div>
  189. </div>
  190. <!-- source -->
  191. <div class="form-group">
  192. <label class="col-sm-3 control-label">Source</label>
  193. <div class="col-sm-9">
  194. <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-19">line 19</a></p>
  195. </div>
  196. </div>
  197. </form>
  198. </div> </div>
  199. </dd>
  200. <hr/>
  201. <dt class="symbol-title member private collapsible-symbol">
  202. <h4 id="_privateMember" class="member private"><span class="signature-attribs">&lt;private> </span><span class="name">_privateMember</span><span class="signature-type"> :string</span></h4>
  203. <div class="summary"><p>A private member of the class.</p></div></dt>
  204. <dd class="symbol-details member private collapsible-symbol">
  205. <div class="symbol-details-inner">
  206. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  207. <!-- type -->
  208. <div class="form-group">
  209. <label class="col-sm-3 control-label">Type</label>
  210. <div class="col-sm-9">
  211. <div class="form-control-static type-names"><span class="param-type">string</span></div>
  212. </div>
  213. </div>
  214. <!-- defaultvalue -->
  215. <div class="form-group">
  216. <label class="col-sm-3 control-label">Default Value</label>
  217. <div class="col-sm-9">
  218. <p class="form-control-static">&quot;Test Global&quot;</p>
  219. </div>
  220. </div>
  221. <!-- source -->
  222. <div class="form-group">
  223. <label class="col-sm-3 control-label">Source</label>
  224. <div class="col-sm-9">
  225. <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-27">line 27</a></p>
  226. </div>
  227. </div>
  228. </form>
  229. </div> </div>
  230. </dd>
  231. </dl>
  232. <h3>Methods</h3>
  233. <dl class="symbol">
  234. <hr/>
  235. <dt class="symbol-title function public collapsible-symbol">
  236. <h4 id="testMethod" class="function public"><span class="name">testMethod</span><span class="signature-params">( <span class="signature-param">value</span>, <span class="signature-param">obj</span> [,&nbsp;<span class="signature-param">...objN</span>&nbsp;]&nbsp;)</span><span class="signature-type"> &rarr;&nbsp;{Object}</span></h4>
  237. <div class="summary"><p>This is a test instance method of the global test class, test <code>markdown</code></p></div></dt>
  238. <dd class="symbol-details function public collapsible-symbol">
  239. <div class="symbol-details-inner">
  240. <div class="callout callout-info">
  241. <h5>Parameters</h5>
  242. <table class="params table table-striped">
  243. <thead>
  244. <tr>
  245. <th>Name</th>
  246. <th>Type</th>
  247. <th>Attributes</th>
  248. <th class="last">Description</th>
  249. </tr>
  250. </thead>
  251. <tbody>
  252. <tr>
  253. <td><code>value</code></td>
  254. <td><span class="param-type">*</span></td>
  255. <td class="attributes"></td>
  256. <td class="last">
  257. <p>Any value, test <code>markdown</code></p>
  258. </td>
  259. </tr>
  260. <tr>
  261. <td><code>obj</code></td>
  262. <td><span class="param-type">Object</span></td>
  263. <td class="attributes"></td>
  264. <td class="last">
  265. <p>The first object of what could be many, test <code>markdown</code></p>
  266. </td>
  267. </tr>
  268. <tr>
  269. <td><code>objN</code></td>
  270. <td><span class="param-type">Object</span></td>
  271. <td class="attributes">&lt;optional&gt;<br/>&lt;repeatable&gt;<br/></td>
  272. <td class="last">
  273. <p>Any additional objects, test <code>markdown</code></p>
  274. </td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. </div>
  279. <div class="callout callout-success"><h5>Returns</h5> <form class="form-horizontal returns">
  280. <div class="form-group">
  281. <label class="col-sm-3 control-label returns-type"><span class="param-type">Object</span></label>
  282. <div class="col-sm-9">
  283. <div class="form-control-static returns-description"><p>The combination of all the objects, test <code>markdown</code>.</p></div>
  284. </div>
  285. </div>
  286. </form>
  287. </div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  288. <!-- source -->
  289. <div class="form-group">
  290. <label class="col-sm-3 control-label">Source</label>
  291. <div class="col-sm-9">
  292. <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-38">line 38</a></p>
  293. </div>
  294. </div>
  295. </form>
  296. </div> </div>
  297. </dd>
  298. <hr/>
  299. <dt class="symbol-title function public collapsible-symbol">
  300. <h4 id="testMethod" class="function public"><span class="name">testMethod</span><span class="signature-params">( <span class="signature-param">type</span>&nbsp;)</span><span class="signature-type"></span></h4>
  301. <div class="summary"><p>This is a test instance method of the global test class to check that global type definitions are documented.</p></div></dt>
  302. <dd class="symbol-details function public collapsible-symbol">
  303. <div class="symbol-details-inner">
  304. <div class="callout callout-info">
  305. <h5>Parameters</h5>
  306. <table class="params table table-striped">
  307. <thead>
  308. <tr>
  309. <th>Name</th>
  310. <th>Type</th>
  311. <th class="last">Description</th>
  312. </tr>
  313. </thead>
  314. <tbody>
  315. <tr>
  316. <td><code>type</code></td>
  317. <td><span class="param-type"><a href="global.html#SomeType">SomeType</a></span></td>
  318. <td class="last">
  319. <p>The parameter which is of type SomeType</p>
  320. </td>
  321. </tr>
  322. </tbody>
  323. </table>
  324. </div>
  325. <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
  326. <!-- source -->
  327. <div class="form-group">
  328. <label class="col-sm-3 control-label">Source</label>
  329. <div class="col-sm-9">
  330. <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-51">line 51</a></p>
  331. </div>
  332. </div>
  333. </form>
  334. </div> </div>
  335. </dd>
  336. </dl>
  337. </article>
  338. </section>
  339. </div>
  340. <div class="col-md-3 side-content">
  341. <nav class="toc hidden-print hidden-sm hidden-xs"></nav>
  342. </div>
  343. </div>
  344. </div>
  345. <footer>
  346. <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
  347. <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>
  348. </footer>
  349. <script src="js/jquery.min.js"></script>
  350. <script src="js/bootstrap.min.js"></script>
  351. <script src="js/clipboard.min.js"></script>
  352. <script src="js/prism.min.js"></script>
  353. <script src="js/template.min.js"></script>
  354. <!-- start:lunr-search-modal.hbs -->
  355. <div class="modal fade" id="lunr-search-modal">
  356. <div class="modal-dialog">
  357. <div class="modal-content">
  358. <div class="modal-header">
  359. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  360. <h4 class="modal-title">Search results</h4>
  361. </div>
  362. <div class="modal-body" id="lunr-search-body">
  363. </div>
  364. <div class="modal-footer" id="lunr-search-footer">
  365. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  366. </div>
  367. </div><!-- /.modal-content -->
  368. </div><!-- /.modal-dialog -->
  369. </div>
  370. <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
  371. </body>
  372. </html>