GlobalClass.js.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <!-- start:source.tmpl.hbs -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width">
  7. <title>GlobalClass.js</title>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
  12. <link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
  13. <link type="text/css" rel="stylesheet" href="css/prism.min.css">
  14. <link type="text/css" rel="stylesheet" href="css/template.min.css">
  15. <script type="text/javascript">
  16. 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};
  17. window.DOCLET_TOC_ENABLED = false;
  18. window.DOCLET_AFILTER_ENABLED = false;
  19. </script>
  20. </head>
  21. <body>
  22. <!-- start:navbar.hbs -->
  23. <header class="navbar navbar-default navbar-fixed-top navbar-inverse">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <a class="navbar-brand" href="index.html">
  27. FooDoc
  28. </a>
  29. <!-- displayed on small devices -->
  30. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. </div>
  36. <div class="navbar-collapse collapse" id="topNavigation">
  37. <ul class="nav navbar-nav">
  38. <li class="dropdown">
  39. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
  40. <ul class="dropdown-menu">
  41. <li><a href="global.html#SomeType">SomeType</a></li>
  42. </ul>
  43. </li>
  44. <li class="dropdown">
  45. <a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  46. <ul class="dropdown-menu">
  47. <li><a href="CustomError.html">CustomError</a></li>
  48. <li><a href="GlobalClass.html">GlobalClass</a></li>
  49. <li><a href="MyApi.Child.html">MyApi.Child</a></li>
  50. <li><a href="MyApi.Class.html">MyApi.Class</a></li>
  51. </ul>
  52. </li>
  53. <li class="dropdown">
  54. <a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  55. <ul class="dropdown-menu">
  56. <li><a href="MyApi.html">MyApi</a></li>
  57. <li><a href="MyApi.utils.html">MyApi.utils</a></li>
  58. </ul>
  59. </li>
  60. <li class="dropdown">
  61. <a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
  62. <ul class="dropdown-menu">
  63. <li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
  64. <li><a href="tutorial-drive-car.html">Drive Car</a></li>
  65. </ul>
  66. </li>
  67. </ul>
  68. <!-- start:lunr-search-navbar.hbs -->
  69. <form class="navbar-form navbar-right" role="search">
  70. <div class="input-group">
  71. <input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
  72. <div class="input-group-btn">
  73. <button class="btn btn-default" id="lunr-search-submit">
  74. <i class="glyphicon glyphicon-search"></i>
  75. </button>
  76. </div>
  77. </div>
  78. </form>
  79. <!-- start:lunr-search-navbar.hbs --> </div>
  80. </div>
  81. </header>
  82. <!-- end:navbar.hbs --> <div class="page-header">
  83. <div class="container">
  84. <span class="kind">source</span>
  85. <h1><span class="name">GlobalClass.js</span></h1>
  86. </div>
  87. </div>
  88. <div class="container content">
  89. <div class="row">
  90. <div class="col-md-12 main-content">
  91. <section class="source-section">
  92. <article></article>
  93. <pre class="prettyprint source language-javascript line-numbers"><code class="language-javascript">/**
  94. * @summary This is the summary of the global test class, test `markdown`.
  95. * @constructor GlobalClass
  96. * @param {string} arg1 - The first test arg, test `markdown`.
  97. * @param {...string} [arg2=false] - A repeatable, optional argument with a default value of false, test `markdown`.
  98. * @description 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 `markdown`
  99. * @example {@caption You can provide example captions with `markdown` and specify the language to use when rendering the code, defaults to `javascript`.}
  100. * var gc = new GlobalClass("arg1", "arg2");
  101. * @example {@lang xml}
  102. * &lt;head>
  103. * &lt;title>HTML Highlighting&lt;/title>
  104. * &lt;script>
  105. * // supports embedded languages
  106. * var gc = new GlobalClass("arg1", "arg2");
  107. * &lt;/script>
  108. * &lt;/head>
  109. */
  110. function GlobalClass(arg1, arg2){
  111. /**
  112. * @summary The name of the class.
  113. * @memberof GlobalClass#
  114. * @name name
  115. * @type {string}
  116. * @default "Test Global"
  117. */
  118. this.name = "Test Global";
  119. /**
  120. * @summary A private member of the class.
  121. * @memberof GlobalClass#
  122. * @name _privateMember
  123. * @type {string}
  124. * @private
  125. * @default "Test Global"
  126. */
  127. this._privateMember = "Private Member";
  128. }
  129. /**
  130. * @summary This is a test instance method of the global test class, test `markdown`
  131. * @memberof GlobalClass#
  132. * @function testMethod
  133. * @param {*} value - Any value, test `markdown`
  134. * @param {Object} obj - The first object of what could be many, test `markdown`
  135. * @param {...Object} [objN] - Any additional objects, test `markdown`
  136. * @returns {Object} The combination of all the objects, test `markdown`.
  137. */
  138. GlobalClass.prototype.testMethod = function(value, obj, objN){
  139. };
  140. /**
  141. * @summary This is a test instance method of the global test class to check that global type definitions are documented.
  142. * @memberof GlobalClass#
  143. * @function testMethod
  144. * @param {SomeType} type - The parameter which is of type SomeType
  145. */
  146. GlobalClass.prototype.testTypeDefMethod = function(type){
  147. };
  148. window.GlobalClass = GlobalClass;
  149. /**
  150. * Some global type.
  151. * @global
  152. * @typedef {Object} SomeType
  153. * @property {string} someProp
  154. */</code></pre>
  155. </section>
  156. </div>
  157. </div>
  158. </div>
  159. <footer>
  160. <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
  161. <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>
  162. </footer>
  163. <script src="js/jquery.min.js"></script>
  164. <script src="js/bootstrap.min.js"></script>
  165. <script src="js/clipboard.min.js"></script>
  166. <script src="js/prism.min.js"></script>
  167. <script src="js/template.min.js"></script>
  168. <!-- start:lunr-search-modal.hbs -->
  169. <div class="modal fade" id="lunr-search-modal">
  170. <div class="modal-dialog">
  171. <div class="modal-content">
  172. <div class="modal-header">
  173. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  174. <h4 class="modal-title">Search results</h4>
  175. </div>
  176. <div class="modal-body" id="lunr-search-body">
  177. </div>
  178. <div class="modal-footer" id="lunr-search-footer">
  179. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  180. </div>
  181. </div><!-- /.modal-content -->
  182. </div><!-- /.modal-dialog -->
  183. </div>
  184. <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
  185. </body>
  186. </html>
  187. <!-- end:source.tmpl.hbs -->