Sākums Izpētīt Palīdzība
Reģistrēties Pierakstīties
bin
/
tourism-wxapp
1
0
Atdalīts 0
Faili Problēmas 0 Izmaiņu pieprasījumi 0 Vikivietne
Koks: 66f00d63c9
Atzari Tagi
tourism-wxapp
/
node_modules
/
foodoc
/
.test
/
MyApi.Class.html

MyApi.Class.html 30 KB
Vēsture Neapstrādāts

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<meta name="viewport" content="width=device-width">
    6. 

  6. 		<title>MyApi.Class</title>
    7. 

  7. 		<!--[if lt IE 9]>
    8. 

  8. 		<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    9. 

  9. 		<![endif]-->
    10. 

  10. 		<link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
    11. 

  11. 		<link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
    12. 

  12. 		<link type="text/css" rel="stylesheet" href="css/prism.min.css">
    13. 

  13. 		<link type="text/css" rel="stylesheet" href="css/template.min.css">
    14. 

  14. 		<script type="text/javascript">
    15. 

  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. 

  16. 			window.DOCLET_TOC_ENABLED = true;
    17. 

  17. 			window.DOCLET_AFILTER_ENABLED = true;
    18. 

  18. 		</script>
    19. 

  19. </head>
    20. 

  20. <body>
    21. 

  21. 	<!-- start:navbar.hbs -->
    22. 

  22. 	<header class="navbar navbar-default navbar-fixed-top navbar-inverse">
    23. 

  23. 		<div class="container">
    24. 

  24. 			<div class="navbar-header">
    25. 

  25. 				<a class="navbar-brand" href="index.html">
    26. 

  26. 					FooDoc
    27. 

  27. 				</a>
    28. 

  28. 				<!-- displayed on small devices -->
    29. 

  29. 				<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
    30. 

  30. 					<span class="icon-bar"></span>
    31. 

  31. 					<span class="icon-bar"></span>
    32. 

  32. 					<span class="icon-bar"></span>
    33. 

  33. 				</button>
    34. 

  34. 			</div>
    35. 

  35. 			<div class="navbar-collapse collapse" id="topNavigation">
    36. 

  36. 				<ul class="nav navbar-nav">
    37. 

  37. 								<li class="dropdown">
    38. 

  38. 									<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
    39. 

  39. 									<ul class="dropdown-menu">
    40. 

  40. 											<li><a href="global.html#SomeType">SomeType</a></li>
    41. 

  41. 									</ul>
    42. 

  42. 								</li>
    43. 

  43. 								<li class="dropdown">
    44. 

  44. 									<a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
    45. 

  45. 									<ul class="dropdown-menu">
    46. 

  46. 											<li><a href="CustomError.html">CustomError</a></li>
    47. 

  47. 											<li><a href="GlobalClass.html">GlobalClass</a></li>
    48. 

  48. 											<li><a href="MyApi.Child.html">MyApi.Child</a></li>
    49. 

  49. 											<li><a href="MyApi.Class.html">MyApi.Class</a></li>
    50. 

  50. 									</ul>
    51. 

  51. 								</li>
    52. 

  52. 								<li class="dropdown">
    53. 

  53. 									<a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
    54. 

  54. 									<ul class="dropdown-menu">
    55. 

  55. 											<li><a href="MyApi.html">MyApi</a></li>
    56. 

  56. 											<li><a href="MyApi.utils.html">MyApi.utils</a></li>
    57. 

  57. 									</ul>
    58. 

  58. 								</li>
    59. 

  59. 								<li class="dropdown">
    60. 

  60. 									<a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
    61. 

  61. 									<ul class="dropdown-menu">
    62. 

  62. 											<li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
    63. 

  63. 											<li><a href="tutorial-drive-car.html">Drive Car</a></li>
    64. 

  64. 									</ul>
    65. 

  65. 								</li>
    66. 

  66. 				</ul>
    67. 

  67. 					<!-- start:lunr-search-navbar.hbs -->
    68. 

  68. 					<form class="navbar-form navbar-right" role="search">
    69. 

  69. 						<div class="input-group">
    70. 

  70. 							<input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
    71. 

  71. 							<div class="input-group-btn">
    72. 

  72. 								<button class="btn btn-default" id="lunr-search-submit">
    73. 

  73. 									<i class="glyphicon glyphicon-search"></i>
    74. 

  74. 								</button>
    75. 

  75. 							</div>
    76. 

  76. 						</div>
    77. 

  77. 					</form>
    78. 

  78. 					<!-- start:lunr-search-navbar.hbs -->		</div>
    79. 

  79. 		</div>
    80. 

  80. 	</header>
    81. 

  81. 	<!-- end:navbar.hbs -->		<div class="page-header">
    82. 

  82. 			<div class="container">
    83. 

  83. 				<span class="kind">class</span>
    84. 

  84. 				<h1><span class="ancestors"><a href="MyApi.html">MyApi</a>.</span><span class="name">Class</span></h1>
    85. 

  85. 				<div class="summary"><p>This is the summary of the MyApi test class, test <code>markdown</code>.</p></div>			</div>
    86. 

  86. 		</div>
    87. 

  87. 	<div class="container content">
    88. 

  88. 		<div class="row">
    89. 

  89. 			<div class="col-md-9 main-content">
    90. 

  90. 						<ol class="breadcrumb">
    91. 

  91. 							<li><a href="index.html">Home</a></li>
    92. 

  92. 							<li><a href="list_class.html">Classes</a></li>
    93. 

  93. 							<li class="active"><a href="MyApi.html">MyApi</a>.Class</li>
    94. 

  94. 						</ol>
    95. 

  95. 						<div class="access-filter">
    96. 

  96. 								<label class="checkbox-inline">
    97. 

  97. 									<input class="toggle-public" type="checkbox" value="" checked>
    98. 

  98. 									Public
    99. 

  99. 								</label>
    100. 

  100. 								<label class="checkbox-inline">
    101. 

  101. 									<input class="toggle-protected" type="checkbox" value="" checked>
    102. 

  102. 									Protected
    103. 

  103. 								</label>
    104. 

  104. 								<label class="checkbox-inline">
    105. 

  105. 									<input class="toggle-private" type="checkbox" value="" checked>
    106. 

  106. 									Private
    107. 

  107. 								</label>
    108. 

  108. 						</div>
    109. 

  109. 					<section>
    110. 

  110. 							<dl class="symbol primary">
    111. 

  111. 								<dt class="symbol-title class collapsible-symbol expanded">
    112. 

  112. 			<h2 class="class"><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></h2>
    113. 

  113. 		<div class="summary"><p>This is the summary of the MyApi test class, test <code>markdown</code>.</p></div></dt>
    114. 

  114. <dd class="symbol-details class  collapsible-symbol expanded" style="max-height: 9999px;">
    115. 

  115. 	<div class="symbol-details-inner">
    116. 

  116. 			<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>
    117. 

  117. 			</div>			<div class="callout callout-info">
    118. 

  118. 				<h5>Parameters</h5>
    119. 

  119. 				<table class="params table table-striped">
    120. 

  120. 					<thead>
    121. 

  121. 					<tr>
    122. 

  122. 							<th>Name</th>
    123. 

  123. 						<th>Type</th>
    124. 

  124. 							<th>Attributes</th>
    125. 

  125. 							<th>Default</th>
    126. 

  126. 						<th class="last">Description</th>
    127. 

  127. 					</tr>
    128. 

  128. 					</thead>
    129. 

  129. 					<tbody>
    130. 

  130. 						<tr>
    131. 

  131. 								<td><code>arg1</code></td>
    132. 

  132. 							<td><span class="param-type">string</span></td>
    133. 

  133. 								<td class="attributes"></td>
    134. 

  134. 								<td></td>
    135. 

  135. 							<td class="last">
    136. 

  136. 									<p>The first test arg, test <code>markdown</code>.</p>
    137. 

  137. 							</td>
    138. 

  138. 						</tr>
    139. 

  139. 						<tr>
    140. 

  140. 								<td><code>arg2</code></td>
    141. 

  141. 							<td><span class="param-type">string</span></td>
    142. 

  142. 								<td class="attributes">&lt;optional&gt;<br/>&lt;repeatable&gt;<br/></td>
    143. 

  143. 								<td>false</td>
    144. 

  144. 							<td class="last">
    145. 

  145. 									<p>A repeatable, optional argument with a default value of false, test <code>markdown</code>.</p>
    146. 

  146. 							</td>
    147. 

  147. 						</tr>
    148. 

  148. 					</tbody>
    149. 

  149. 				</table>
    150. 

  150. 			</div>
    151. 

  151. 			<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>
    152. 

  152. 					<div class="example-code">
    153. 

  153. 						<pre class="prettyprint source language-javascript"><code class="language-javascript">
var gc &#x3D; new GlobalClass(&quot;arg1&quot;, &quot;arg2&quot;);</code></pre>
    154. 

  154. 					</div>
    155. 

  155. 					<div class="example-code">
    156. 

  156. 						<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>
    157. 

  157. 					</div>
    158. 

  158. 			</div>			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    159. 

  159. 			
    160. 

  160. 			
    161. 

  161. 			
    162. 

  162. 			
    163. 

  163. 			
    164. 

  164. 			
    165. 

  165. 			
    166. 

  166. 			
    167. 

  167. 			
    168. 

  168. 			
    169. 

  169. 			
    170. 

  170. 			
    171. 

  171. 			
    172. 

  172. 			
    173. 

  173. 			
    174. 

  174. 							<!-- source -->
    175. 

  175. 							<div class="form-group">
    176. 

  176. 								<label class="col-sm-3 control-label">Source</label>
    177. 

  177. 								<div class="col-sm-9">
    178. 

  178. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-25">line 25</a></p>
    179. 

  179. 								</div>
    180. 

  180. 							</div>
    181. 

  181. 			
    182. 

  182. 			
    183. 

  183. 			
    184. 

  184. 			
    185. 

  185. 					</form>
    186. 

  186. 			</div>	</div>
    187. 

  187. </dd>
    188. 

  188. 							</dl>
    189. 

  189. 							<article class="secondary">
    190. 

  190. 									<h3>Members</h3>
    191. 

  191. 									<dl class="symbol">
    192. 

  192. 											<hr/>
    193. 

  193. 											<dt class="symbol-title member public collapsible-symbol">
    194. 

  194. 			<h4 id="publicMember" class="member public"><span class="name">publicMember</span><span class="signature-type"> :string</span></h4>
    195. 

  195. 				<div class="summary"><p>I'm a member of the class.</p></div></dt>
    196. 

  196. <dd class="symbol-details member public  collapsible-symbol">
    197. 

  197. 	<div class="symbol-details-inner">
    198. 

  198. 			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    199. 

  199. 			
    200. 

  200. 							<!-- type -->
    201. 

  201. 							<div class="form-group">
    202. 

  202. 								<label class="col-sm-3 control-label">Type</label>
    203. 

  203. 								<div class="col-sm-9">
    204. 

  204. 									<div class="form-control-static type-names"><span class="param-type">string</span></div>
    205. 

  205. 								</div>
    206. 

  206. 							</div>
    207. 

  207. 			
    208. 

  208. 							<!-- defaultvalue -->
    209. 

  209. 							<div class="form-group">
    210. 

  210. 								<label class="col-sm-3 control-label">Default Value</label>
    211. 

  211. 								<div class="col-sm-9">
    212. 

  212. 									<p class="form-control-static">&quot;I&#x27;m an instance member.&quot;</p>
    213. 

  213. 								</div>
    214. 

  214. 							</div>
    215. 

  215. 			
    216. 

  216. 			
    217. 

  217. 			
    218. 

  218. 			
    219. 

  219. 			
    220. 

  220. 			
    221. 

  221. 			
    222. 

  222. 			
    223. 

  223. 			
    224. 

  224. 			
    225. 

  225. 			
    226. 

  226. 			
    227. 

  227. 			
    228. 

  228. 							<!-- source -->
    229. 

  229. 							<div class="form-group">
    230. 

  230. 								<label class="col-sm-3 control-label">Source</label>
    231. 

  231. 								<div class="col-sm-9">
    232. 

  232. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-44">line 44</a></p>
    233. 

  233. 								</div>
    234. 

  234. 							</div>
    235. 

  235. 			
    236. 

  236. 			
    237. 

  237. 			
    238. 

  238. 			
    239. 

  239. 					</form>
    240. 

  240. 			</div>	</div>
    241. 

  241. </dd>
    242. 

  242. 											<hr/>
    243. 

  243. 											<dt class="symbol-title member protected collapsible-symbol">
    244. 

  244. 			<h4 id="protectedMember" class="member protected"><span class="signature-attribs">&lt;protected> </span><span class="name">protectedMember</span><span class="signature-type"> :string</span></h4>
    245. 

  245. 				<div class="summary"><p>I'm a protected member of the class.</p></div></dt>
    246. 

  246. <dd class="symbol-details member protected  collapsible-symbol">
    247. 

  247. 	<div class="symbol-details-inner">
    248. 

  248. 			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    249. 

  249. 			
    250. 

  250. 							<!-- type -->
    251. 

  251. 							<div class="form-group">
    252. 

  252. 								<label class="col-sm-3 control-label">Type</label>
    253. 

  253. 								<div class="col-sm-9">
    254. 

  254. 									<div class="form-control-static type-names"><span class="param-type">string</span></div>
    255. 

  255. 								</div>
    256. 

  256. 							</div>
    257. 

  257. 			
    258. 

  258. 							<!-- defaultvalue -->
    259. 

  259. 							<div class="form-group">
    260. 

  260. 								<label class="col-sm-3 control-label">Default Value</label>
    261. 

  261. 								<div class="col-sm-9">
    262. 

  262. 									<p class="form-control-static">&quot;I&#x27;m a protected member.&quot;</p>
    263. 

  263. 								</div>
    264. 

  264. 							</div>
    265. 

  265. 			
    266. 

  266. 			
    267. 

  267. 			
    268. 

  268. 			
    269. 

  269. 			
    270. 

  270. 			
    271. 

  271. 			
    272. 

  272. 			
    273. 

  273. 			
    274. 

  274. 			
    275. 

  275. 			
    276. 

  276. 			
    277. 

  277. 			
    278. 

  278. 							<!-- source -->
    279. 

  279. 							<div class="form-group">
    280. 

  280. 								<label class="col-sm-3 control-label">Source</label>
    281. 

  281. 								<div class="col-sm-9">
    282. 

  282. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-52">line 52</a></p>
    283. 

  283. 								</div>
    284. 

  284. 							</div>
    285. 

  285. 			
    286. 

  286. 			
    287. 

  287. 			
    288. 

  288. 			
    289. 

  289. 					</form>
    290. 

  290. 			</div>	</div>
    291. 

  291. </dd>
    292. 

  292. 											<hr/>
    293. 

  293. 											<dt class="symbol-title member private collapsible-symbol">
    294. 

  294. 			<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>
    295. 

  295. 				<div class="summary"><p>I'm a private member of the class.</p></div></dt>
    296. 

  296. <dd class="symbol-details member private  collapsible-symbol">
    297. 

  297. 	<div class="symbol-details-inner">
    298. 

  298. 			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    299. 

  299. 			
    300. 

  300. 							<!-- type -->
    301. 

  301. 							<div class="form-group">
    302. 

  302. 								<label class="col-sm-3 control-label">Type</label>
    303. 

  303. 								<div class="col-sm-9">
    304. 

  304. 									<div class="form-control-static type-names"><span class="param-type">string</span></div>
    305. 

  305. 								</div>
    306. 

  306. 							</div>
    307. 

  307. 			
    308. 

  308. 							<!-- defaultvalue -->
    309. 

  309. 							<div class="form-group">
    310. 

  310. 								<label class="col-sm-3 control-label">Default Value</label>
    311. 

  311. 								<div class="col-sm-9">
    312. 

  312. 									<p class="form-control-static">&quot;I&#x27;m a private member.&quot;</p>
    313. 

  313. 								</div>
    314. 

  314. 							</div>
    315. 

  315. 			
    316. 

  316. 			
    317. 

  317. 			
    318. 

  318. 			
    319. 

  319. 			
    320. 

  320. 			
    321. 

  321. 			
    322. 

  322. 			
    323. 

  323. 			
    324. 

  324. 			
    325. 

  325. 			
    326. 

  326. 			
    327. 

  327. 			
    328. 

  328. 							<!-- source -->
    329. 

  329. 							<div class="form-group">
    330. 

  330. 								<label class="col-sm-3 control-label">Source</label>
    331. 

  331. 								<div class="col-sm-9">
    332. 

  332. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-61">line 61</a></p>
    333. 

  333. 								</div>
    334. 

  334. 							</div>
    335. 

  335. 			
    336. 

  336. 			
    337. 

  337. 			
    338. 

  338. 			
    339. 

  339. 					</form>
    340. 

  340. 			</div>	</div>
    341. 

  341. </dd>
    342. 

  342. 									</dl>
    343. 

  343. 									<h3>Methods</h3>
    344. 

  344. 									<dl class="symbol">
    345. 

  345. 											<hr/>
    346. 

  346. 											<dt class="symbol-title function public collapsible-symbol">
    347. 

  347. 			<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>
    348. 

  348. 				<div class="summary"><p>This is a test instance method of the MyApi test class, test <code>markdown</code>.</p></div></dt>
    349. 

  349. <dd class="symbol-details function public  collapsible-symbol">
    350. 

  350. 	<div class="symbol-details-inner">
    351. 

  351. 			<div class="callout callout-primary"><h5>Description</h5>		<div class="description"><p>This method is not overridden in the <a href="MyApi.Child.html">MyApi.Child</a> class but is simply inherited.</p></div>
    352. 

  352. 			</div>			<div class="callout callout-info">
    353. 

  353. 				<h5>Parameters</h5>
    354. 

  354. 				<table class="params table table-striped">
    355. 

  355. 					<thead>
    356. 

  356. 					<tr>
    357. 

  357. 							<th>Name</th>
    358. 

  358. 						<th>Type</th>
    359. 

  359. 							<th>Attributes</th>
    360. 

  360. 						<th class="last">Description</th>
    361. 

  361. 					</tr>
    362. 

  362. 					</thead>
    363. 

  363. 					<tbody>
    364. 

  364. 						<tr>
    365. 

  365. 								<td><code>value</code></td>
    366. 

  366. 							<td><span class="param-type">*</span></td>
    367. 

  367. 								<td class="attributes"></td>
    368. 

  368. 							<td class="last">
    369. 

  369. 									<p>Any value, test <code>markdown</code></p>
    370. 

  370. 							</td>
    371. 

  371. 						</tr>
    372. 

  372. 						<tr>
    373. 

  373. 								<td><code>obj</code></td>
    374. 

  374. 							<td><span class="param-type">Object</span></td>
    375. 

  375. 								<td class="attributes"></td>
    376. 

  376. 							<td class="last">
    377. 

  377. 									<p>The first object of what could be many, test <code>markdown</code></p>
    378. 

  378. 							</td>
    379. 

  379. 						</tr>
    380. 

  380. 						<tr>
    381. 

  381. 								<td><code>objN</code></td>
    382. 

  382. 							<td><span class="param-type">Object</span></td>
    383. 

  383. 								<td class="attributes">&lt;optional&gt;<br/>&lt;repeatable&gt;<br/></td>
    384. 

  384. 							<td class="last">
    385. 

  385. 									<p>Any additional objects, test <code>markdown</code></p>
    386. 

  386. 							</td>
    387. 

  387. 						</tr>
    388. 

  388. 					</tbody>
    389. 

  389. 				</table>
    390. 

  390. 			</div>
    391. 

  391. 			<div class="callout callout-success"><h5>Returns</h5>		<form class="form-horizontal returns">
    392. 

  392. 							<div class="form-group">
    393. 

  393. 								<label class="col-sm-3 control-label returns-type"><span class="param-type">Object</span></label>
    394. 

  394. 								<div class="col-sm-9">
    395. 

  395. 									<div class="form-control-static returns-description"><p>The combination of all the objects, test <code>markdown</code>.</p></div>
    396. 

  396. 								</div>
    397. 

  397. 							</div>
    398. 

  398. 					</form>
    399. 

  399. 			</div>			<div class="callout callout-warning"><h5>Fires</h5>		<form class="form-horizontal fires">
    400. 

  400. 							<div class="form-group">
    401. 

  401. 								<label class="col-sm-3 control-label fires-event"><a href="MyApi.Class.html#~event:test.my-api">"test.my-api"</a></label>
    402. 

  402. 								<div class="col-sm-9">
    403. 

  403. 									<div class="form-control-static fires-summary"><p>This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.</p></div>
    404. 

  404. 								</div>
    405. 

  405. 							</div>
    406. 

  406. 					</form>
    407. 

  407. 			</div>			<div class="callout callout-danger"><h5>Throws</h5>		<form class="form-horizontal exceptions">
    408. 

  408. 							<div class="form-group">
    409. 

  409. 								<label class="col-sm-3 control-label exceptions-type"><span class="param-type"><a href="CustomError.html">CustomError</a></span></label>
    410. 

  410. 								<div class="col-sm-9">
    411. 

  411. 									<div class="form-control-static exceptions-description"><p>This is thrown when some condition fails within this method.</p></div>
    412. 

  412. 								</div>
    413. 

  413. 							</div>
    414. 

  414. 					</form>
    415. 

  415. 			</div>			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    416. 

  416. 			
    417. 

  417. 			
    418. 

  418. 			
    419. 

  419. 			
    420. 

  420. 			
    421. 

  421. 			
    422. 

  422. 			
    423. 

  423. 			
    424. 

  424. 			
    425. 

  425. 			
    426. 

  426. 			
    427. 

  427. 			
    428. 

  428. 			
    429. 

  429. 			
    430. 

  430. 			
    431. 

  431. 							<!-- source -->
    432. 

  432. 							<div class="form-group">
    433. 

  433. 								<label class="col-sm-3 control-label">Source</label>
    434. 

  434. 								<div class="col-sm-9">
    435. 

  435. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-72">line 72</a></p>
    436. 

  436. 								</div>
    437. 

  437. 							</div>
    438. 

  438. 			
    439. 

  439. 			
    440. 

  440. 			
    441. 

  441. 			
    442. 

  442. 					</form>
    443. 

  443. 			</div>	</div>
    444. 

  444. </dd>
    445. 

  445. 											<hr/>
    446. 

  446. 											<dt class="symbol-title function public collapsible-symbol">
    447. 

  447. 			<h4 id="anotherMethod" class="function public"><span class="name">anotherMethod</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>
    448. 

  448. 				<div class="summary"><p>This is a another test instance method of the MyApi test class, test <code>markdown</code>.</p></div></dt>
    449. 

  449. <dd class="symbol-details function public  collapsible-symbol">
    450. 

  450. 	<div class="symbol-details-inner">
    451. 

  451. 			<div class="callout callout-primary"><h5>Description</h5>		<div class="description"><p>This method is overridden in the <a href="MyApi.Child.html">MyApi.Child</a> class and should remove the exception documentation as it no longer applies.</p></div>
    452. 

  452. 			</div>			<div class="callout callout-info">
    453. 

  453. 				<h5>Parameters</h5>
    454. 

  454. 				<table class="params table table-striped">
    455. 

  455. 					<thead>
    456. 

  456. 					<tr>
    457. 

  457. 							<th>Name</th>
    458. 

  458. 						<th>Type</th>
    459. 

  459. 							<th>Attributes</th>
    460. 

  460. 						<th class="last">Description</th>
    461. 

  461. 					</tr>
    462. 

  462. 					</thead>
    463. 

  463. 					<tbody>
    464. 

  464. 						<tr>
    465. 

  465. 								<td><code>value</code></td>
    466. 

  466. 							<td><span class="param-type">*</span></td>
    467. 

  467. 								<td class="attributes"></td>
    468. 

  468. 							<td class="last">
    469. 

  469. 									<p>Any value, test <code>markdown</code></p>
    470. 

  470. 							</td>
    471. 

  471. 						</tr>
    472. 

  472. 						<tr>
    473. 

  473. 								<td><code>obj</code></td>
    474. 

  474. 							<td><span class="param-type">Object</span></td>
    475. 

  475. 								<td class="attributes"></td>
    476. 

  476. 							<td class="last">
    477. 

  477. 									<p>The first object of what could be many, test <code>markdown</code></p>
    478. 

  478. 							</td>
    479. 

  479. 						</tr>
    480. 

  480. 						<tr>
    481. 

  481. 								<td><code>objN</code></td>
    482. 

  482. 							<td><span class="param-type">Object</span></td>
    483. 

  483. 								<td class="attributes">&lt;optional&gt;<br/>&lt;repeatable&gt;<br/></td>
    484. 

  484. 							<td class="last">
    485. 

  485. 									<p>Any additional objects, test <code>markdown</code></p>
    486. 

  486. 							</td>
    487. 

  487. 						</tr>
    488. 

  488. 					</tbody>
    489. 

  489. 				</table>
    490. 

  490. 			</div>
    491. 

  491. 			<div class="callout callout-success"><h5>Returns</h5>		<form class="form-horizontal returns">
    492. 

  492. 							<div class="form-group">
    493. 

  493. 								<label class="col-sm-3 control-label returns-type"><span class="param-type">Object</span></label>
    494. 

  494. 								<div class="col-sm-9">
    495. 

  495. 									<div class="form-control-static returns-description"><p>The combination of all the objects, test <code>markdown</code>.</p></div>
    496. 

  496. 								</div>
    497. 

  497. 							</div>
    498. 

  498. 					</form>
    499. 

  499. 			</div>			<div class="callout callout-warning"><h5>Fires</h5>		<form class="form-horizontal fires">
    500. 

  500. 							<div class="form-group">
    501. 

  501. 								<label class="col-sm-3 control-label fires-event"><a href="MyApi.Class.html#~event:another.my-api">"another.my-api"</a></label>
    502. 

  502. 								<div class="col-sm-9">
    503. 

  503. 									<div class="form-control-static fires-summary"><p>This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.</p></div>
    504. 

  504. 								</div>
    505. 

  505. 							</div>
    506. 

  506. 					</form>
    507. 

  507. 			</div>			<div class="callout callout-danger"><h5>Throws</h5>		<form class="form-horizontal exceptions">
    508. 

  508. 							<div class="form-group">
    509. 

  509. 								<label class="col-sm-3 control-label exceptions-type"><span class="param-type"><a href="CustomError.html">CustomError</a></span></label>
    510. 

  510. 								<div class="col-sm-9">
    511. 

  511. 									<div class="form-control-static exceptions-description"><p>This is thrown when some condition fails within this method.</p></div>
    512. 

  512. 								</div>
    513. 

  513. 							</div>
    514. 

  514. 					</form>
    515. 

  515. 			</div>			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    516. 

  516. 			
    517. 

  517. 			
    518. 

  518. 			
    519. 

  519. 			
    520. 

  520. 			
    521. 

  521. 			
    522. 

  522. 			
    523. 

  523. 			
    524. 

  524. 			
    525. 

  525. 			
    526. 

  526. 			
    527. 

  527. 			
    528. 

  528. 			
    529. 

  529. 			
    530. 

  530. 			
    531. 

  531. 							<!-- source -->
    532. 

  532. 							<div class="form-group">
    533. 

  533. 								<label class="col-sm-3 control-label">Source</label>
    534. 

  534. 								<div class="col-sm-9">
    535. 

  535. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-95">line 95</a></p>
    536. 

  536. 								</div>
    537. 

  537. 							</div>
    538. 

  538. 			
    539. 

  539. 			
    540. 

  540. 			
    541. 

  541. 			
    542. 

  542. 					</form>
    543. 

  543. 			</div>	</div>
    544. 

  544. </dd>
    545. 

  545. 									</dl>
    546. 

  546. 									<h3>Type Definitions</h3>
    547. 

  547. 									<dl class="symbol">
    548. 

  548. 											<hr/>
    549. 

  549. 											<dt class="symbol-title typedef public collapsible-symbol">
    550. 

  550. 			<h4 id="~Object" class="typedef public"><span class="name">Object</span></h4>
    551. 

  551. 				<div class="summary"><p>This is a test type definition on the MyApi.Class class.</p></div></dt>
    552. 

  552. <dd class="symbol-details typedef public  collapsible-symbol">
    553. 

  553. 	<div class="symbol-details-inner">
    554. 

  554. 			<div class="callout callout-info">
    555. 

  555. 				<h5>Properties</h5>
    556. 

  556. 				<table class="params table table-striped">
    557. 

  557. 					<thead>
    558. 

  558. 					<tr>
    559. 

  559. 							<th>Name</th>
    560. 

  560. 						<th>Type</th>
    561. 

  561. 							<th>Attributes</th>
    562. 

  562. 							<th>Default</th>
    563. 

  563. 						<th class="last">Description</th>
    564. 

  564. 					</tr>
    565. 

  565. 					</thead>
    566. 

  566. 					<tbody>
    567. 

  567. 						<tr>
    568. 

  568. 								<td><code>name</code></td>
    569. 

  569. 							<td><span class="param-type">string</span></td>
    570. 

  570. 								<td class="attributes"></td>
    571. 

  571. 								<td></td>
    572. 

  572. 							<td class="last">
    573. 

  573. 									<p>The name of the test object.</p>
    574. 

  574. 							</td>
    575. 

  575. 						</tr>
    576. 

  576. 						<tr>
    577. 

  577. 								<td><code>enabled</code></td>
    578. 

  578. 							<td><span class="param-type">boolean</span></td>
    579. 

  579. 								<td class="attributes">&lt;optional&gt;<br/></td>
    580. 

  580. 								<td>false</td>
    581. 

  581. 							<td class="last">
    582. 

  582. 									<p>Whether or not the test object is enabled. Defaults to <code>false</code>.</p>
    583. 

  583. 							</td>
    584. 

  584. 						</tr>
    585. 

  585. 						<tr>
    586. 

  586. 								<td><code>sub</code></td>
    587. 

  587. 							<td><span class="param-type">Object</span></td>
    588. 

  588. 								<td class="attributes"></td>
    589. 

  589. 								<td></td>
    590. 

  590. 							<td class="last">
    591. 

  591. 									<p>An object containing a subset of properties.</p>
    592. 

  592. 										<table class="params table table-striped">
    593. 

  593. 											<thead>
    594. 

  594. 											<tr>
    595. 

  595. 													<th>Name</th>
    596. 

  596. 												<th>Type</th>
    597. 

  597. 													<th>Attributes</th>
    598. 

  598. 													<th>Default</th>
    599. 

  599. 												<th class="last">Description</th>
    600. 

  600. 											</tr>
    601. 

  601. 											</thead>
    602. 

  602. 											<tbody>
    603. 

  603. 												<tr>
    604. 

  604. 														<td><code>id</code></td>
    605. 

  605. 													<td><span class="param-type">number</span></td>
    606. 

  606. 														<td class="attributes"></td>
    607. 

  607. 														<td></td>
    608. 

  608. 													<td class="last">
    609. 

  609. 															<p>The subset id.</p>
    610. 

  610. 													</td>
    611. 

  611. 												</tr>
    612. 

  612. 												<tr>
    613. 

  613. 														<td><code>name</code></td>
    614. 

  614. 													<td><span class="param-type">boolean</span></td>
    615. 

  615. 														<td class="attributes">&lt;optional&gt;<br/></td>
    616. 

  616. 														<td>&quot;Sub Options&quot;</td>
    617. 

  617. 													<td class="last">
    618. 

  618. 															<p>The name of the sub object. Defaults to <code>&quot;Sub Options&quot;</code>.</p>
    619. 

  619. 													</td>
    620. 

  620. 												</tr>
    621. 

  621. 											</tbody>
    622. 

  622. 										</table>
    623. 

  623. 							</td>
    624. 

  624. 						</tr>
    625. 

  625. 					</tbody>
    626. 

  626. 				</table>
    627. 

  627. 			</div>
    628. 

  628. 			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    629. 

  629. 			
    630. 

  630. 							<!-- type -->
    631. 

  631. 							<div class="form-group">
    632. 

  632. 								<label class="col-sm-3 control-label">Type</label>
    633. 

  633. 								<div class="col-sm-9">
    634. 

  634. 									<div class="form-control-static type-names"><span class="param-type">Object</span></div>
    635. 

  635. 								</div>
    636. 

  636. 							</div>
    637. 

  637. 			
    638. 

  638. 			
    639. 

  639. 			
    640. 

  640. 			
    641. 

  641. 			
    642. 

  642. 			
    643. 

  643. 			
    644. 

  644. 			
    645. 

  645. 			
    646. 

  646. 			
    647. 

  647. 			
    648. 

  648. 			
    649. 

  649. 			
    650. 

  650. 			
    651. 

  651. 							<!-- source -->
    652. 

  652. 							<div class="form-group">
    653. 

  653. 								<label class="col-sm-3 control-label">Source</label>
    654. 

  654. 								<div class="col-sm-9">
    655. 

  655. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-117">line 117</a></p>
    656. 

  656. 								</div>
    657. 

  657. 							</div>
    658. 

  658. 			
    659. 

  659. 			
    660. 

  660. 			
    661. 

  661. 			
    662. 

  662. 					</form>
    663. 

  663. 			</div>	</div>
    664. 

  664. </dd>
    665. 

  665. 									</dl>
    666. 

  666. 									<h3>Events</h3>
    667. 

  667. 									<dl class="symbol">
    668. 

  668. 											<hr/>
    669. 

  669. 											<dt class="symbol-title event public collapsible-symbol">
    670. 

  670. 			<h4 id="~event:test.my-api" class="event public"><span class="name">"test.my-api"</span></h4>
    671. 

  671. 				<div class="summary"><p>This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.</p></div></dt>
    672. 

  672. <dd class="symbol-details event public  collapsible-symbol">
    673. 

  673. 	<div class="symbol-details-inner">
    674. 

  674. 			<div class="callout callout-info">
    675. 

  675. 				<h5>Parameters</h5>
    676. 

  676. 				<table class="params table table-striped">
    677. 

  677. 					<thead>
    678. 

  678. 					<tr>
    679. 

  679. 							<th>Name</th>
    680. 

  680. 						<th>Type</th>
    681. 

  681. 						<th class="last">Description</th>
    682. 

  682. 					</tr>
    683. 

  683. 					</thead>
    684. 

  684. 					<tbody>
    685. 

  685. 						<tr>
    686. 

  686. 								<td><code>e</code></td>
    687. 

  687. 							<td><span class="param-type">Event</span></td>
    688. 

  688. 							<td class="last">
    689. 

  689. 									<p>The event object.</p>
    690. 

  690. 							</td>
    691. 

  691. 						</tr>
    692. 

  692. 						<tr>
    693. 

  693. 								<td><code>custom</code></td>
    694. 

  694. 							<td><span class="param-type">*</span></td>
    695. 

  695. 							<td class="last">
    696. 

  696. 									<p>Some custom parameter passed to any listeners.</p>
    697. 

  697. 							</td>
    698. 

  698. 						</tr>
    699. 

  699. 					</tbody>
    700. 

  700. 				</table>
    701. 

  701. 			</div>
    702. 

  702. 			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    703. 

  703. 			
    704. 

  704. 			
    705. 

  705. 			
    706. 

  706. 			
    707. 

  707. 			
    708. 

  708. 			
    709. 

  709. 			
    710. 

  710. 			
    711. 

  711. 			
    712. 

  712. 			
    713. 

  713. 			
    714. 

  714. 			
    715. 

  715. 			
    716. 

  716. 			
    717. 

  717. 			
    718. 

  718. 							<!-- source -->
    719. 

  719. 							<div class="form-group">
    720. 

  720. 								<label class="col-sm-3 control-label">Source</label>
    721. 

  721. 								<div class="col-sm-9">
    722. 

  722. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-85">line 85</a></p>
    723. 

  723. 								</div>
    724. 

  724. 							</div>
    725. 

  725. 			
    726. 

  726. 			
    727. 

  727. 			
    728. 

  728. 			
    729. 

  729. 					</form>
    730. 

  730. 			</div>	</div>
    731. 

  731. </dd>
    732. 

  732. 											<hr/>
    733. 

  733. 											<dt class="symbol-title event public collapsible-symbol">
    734. 

  734. 			<h4 id="~event:another.my-api" class="event public"><span class="name">"another.my-api"</span></h4>
    735. 

  735. 				<div class="summary"><p>This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.</p></div></dt>
    736. 

  736. <dd class="symbol-details event public  collapsible-symbol">
    737. 

  737. 	<div class="symbol-details-inner">
    738. 

  738. 			<div class="callout callout-info">
    739. 

  739. 				<h5>Parameters</h5>
    740. 

  740. 				<table class="params table table-striped">
    741. 

  741. 					<thead>
    742. 

  742. 					<tr>
    743. 

  743. 							<th>Name</th>
    744. 

  744. 						<th>Type</th>
    745. 

  745. 						<th class="last">Description</th>
    746. 

  746. 					</tr>
    747. 

  747. 					</thead>
    748. 

  748. 					<tbody>
    749. 

  749. 						<tr>
    750. 

  750. 								<td><code>e</code></td>
    751. 

  751. 							<td><span class="param-type">Event</span></td>
    752. 

  752. 							<td class="last">
    753. 

  753. 									<p>The event object.</p>
    754. 

  754. 							</td>
    755. 

  755. 						</tr>
    756. 

  756. 						<tr>
    757. 

  757. 								<td><code>custom</code></td>
    758. 

  758. 							<td><span class="param-type">*</span></td>
    759. 

  759. 							<td class="last">
    760. 

  760. 									<p>Some custom parameter passed to any listeners.</p>
    761. 

  761. 							</td>
    762. 

  762. 						</tr>
    763. 

  763. 					</tbody>
    764. 

  764. 				</table>
    765. 

  765. 			</div>
    766. 

  766. 			<div class="callout callout-default"><h5>Details</h5>		<form class="form-horizontal details">
    767. 

  767. 			
    768. 

  768. 			
    769. 

  769. 			
    770. 

  770. 			
    771. 

  771. 			
    772. 

  772. 			
    773. 

  773. 			
    774. 

  774. 			
    775. 

  775. 			
    776. 

  776. 			
    777. 

  777. 			
    778. 

  778. 			
    779. 

  779. 			
    780. 

  780. 			
    781. 

  781. 			
    782. 

  782. 							<!-- source -->
    783. 

  783. 							<div class="form-group">
    784. 

  784. 								<label class="col-sm-3 control-label">Source</label>
    785. 

  785. 								<div class="col-sm-9">
    786. 

  786. 									<p class="form-control-static"><a href="MyApi.js.html">MyApi.js</a>, <a href="MyApi.js.html#line-108">line 108</a></p>
    787. 

  787. 								</div>
    788. 

  788. 							</div>
    789. 

  789. 			
    790. 

  790. 			
    791. 

  791. 			
    792. 

  792. 			
    793. 

  793. 					</form>
    794. 

  794. 			</div>	</div>
    795. 

  795. </dd>
    796. 

  796. 									</dl>
    797. 

  797. 							</article>
    798. 

  798. 					</section>
    799. 

  799. 			</div>
    800. 

  800. 				<div class="col-md-3 side-content">
    801. 

  801. 					<nav class="toc hidden-print hidden-sm hidden-xs"></nav>
    802. 

  802. 				</div>
    803. 

  803. 		</div>
    804. 

  804. 	</div>
    805. 

  805. 	<footer>
    806. 

  806. 				<div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
    807. 

  807. 			<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>
    808. 

  808. 	</footer>
    809. 

  809. 	<script src="js/jquery.min.js"></script>
    810. 

  810. 	<script src="js/bootstrap.min.js"></script>
    811. 

  811. 	<script src="js/clipboard.min.js"></script>
    812. 

  812. 	<script src="js/prism.min.js"></script>
    813. 

  813. 	<script src="js/template.min.js"></script>
    814. 

  814. 		<!-- start:lunr-search-modal.hbs -->
    815. 

  815. 		<div class="modal fade" id="lunr-search-modal">
    816. 

  816. 			<div class="modal-dialog">
    817. 

  817. 				<div class="modal-content">
    818. 

  818. 					<div class="modal-header">
    819. 

  819. 						<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
    820. 

  820. 						<h4 class="modal-title">Search results</h4>
    821. 

  821. 					</div>
    822. 

  822. 					<div class="modal-body" id="lunr-search-body">
    823. 

  823. 					</div>
    824. 

  824. 					<div class="modal-footer" id="lunr-search-footer">
    825. 

  825. 						<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
    826. 

  826. 					</div>
    827. 

  827. 				</div><!-- /.modal-content -->
    828. 

  828. 			</div><!-- /.modal-dialog -->
    829. 

  829. 		</div>
    830. 

  830. 		<!-- end:lunr-search-modal.hbs -->		<script src="js/lunr.min.js"></script>
    831. 

  831. 	
    832. 

  832. </body>
    833. 

  833. </html>
    834.