PageRenderTime 343ms CodeModel.GetById 15ms RepoModel.GetById 1ms app.codeStats 1ms

/trunk/jsdoc-toolkit/templates/jsdoc/class.tmpl

http://jsdoc-toolkit.googlecode.com/
Go Template | 649 lines | 603 code | 46 blank | 0 comment | 0 complexity | 747387d2ee192b58d6c22a0a39381aa9 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4. 

  4. 	<head>
    5. 

  5. 		<meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
    6. 

  6. 		<meta name="generator" content="JsDoc Toolkit" />
    7. 

  7. 		{! Link.base = "../"; /* all generated links will be relative to this */ !}
    8. 

  8. 		<title>JsDoc Reference - {+data.alias+}</title>
    9. 

  9. 

  10. 		<style type="text/css">
    11. 

  11. 			{+include("static/default.css")+}
    12. 

  12. 		</style>
    13. 

  13. 	</head>
    14. 

  14. 

  15. 	<body>
    16. 

  16. <!-- ============================== header ================================= -->	
    17. 

  17. 		<!-- begin static/header.html -->
    18. 

  18. 		{+include("static/header.html")+}
    19. 

  19. 		<!-- end static/header.html -->
    20. 

  20. 

  21. <!-- ============================== classes index ============================ -->
    22. 

  22. 		<div id="index">
    23. 

  23. 			<!-- begin publish.classesIndex -->
    24. 

  24. 			{+publish.classesIndex+}
    25. 

  25. 			<!-- end publish.classesIndex -->
    26. 

  26. 		</div>
    27. 

  27. 		
    28. 

  28. 		<div id="content">
    29. 

  29. <!-- ============================== class title ============================ -->
    30. 

  30. 			<h1 class="classTitle">
    31. 

  31. 				{!
    32. 

  32. 					var classType = "";
    33. 

  33. 					
    34. 

  34. 					if (data.isBuiltin()) {
    35. 

  35. 						classType += "Built-In ";
    36. 

  36. 					}
    37. 

  37. 					
    38. 

  38. 					if (data.isNamespace) {
    39. 

  39. 						if (data.is('FUNCTION')) {
    40. 

  40. 							classType += "Function ";
    41. 

  41. 						}
    42. 

  42. 						classType += "Namespace ";
    43. 

  43. 					}
    44. 

  44. 					else {
    45. 

  45. 						classType += "Class ";
    46. 

  46. 					}
    47. 

  47. 				!}
    48. 

  48. 				{+classType+}{+data.alias+}
    49. 

  49. 			</h1>
    50. 

  50. 

  51. <!-- ============================== class summary ========================== -->			
    52. 

  52. 			<p class="description">
    53. 

  53. 				<if test="data.version"><br />Version
    54. 

  54. 					{+ data.version +}.<br />
    55. 

  55. 				</if>
    56. 

  56. 				<if test="data.augments.length"><br />Extends
    57. 

  57. 					{+
    58. 

  58. 						data.augments
    59. 

  59. 						.sort()
    60. 

  60. 						.map(
    61. 

  61. 							function($) { return new Link().toSymbol($); }
    62. 

  62. 						)
    63. 

  63. 						.join(", ")
    64. 

  64. 					+}.<br />
    65. 

  65. 				</if>
    66. 

  66. 			
    67. 

  67. 				{+resolveLinks(data.classDesc)+}
    68. 

  68. 				
    69. 

  69. 				<if test="!data.isBuiltin()">{# isn't defined in any file #}
    70. 

  70. 					<br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}.
    71. 

  71. 				</if>
    72. 

  72. 			</p>
    73. 

  73. 

  74. <!-- ============================== constructor summary ==================== -->			
    75. 

  75. 			<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
    76. 

  76. 			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class {+data.alias+}.">
    77. 

  77. 				<caption>{+classType+}Summary</caption>
    78. 

  78. 				<thead>
    79. 

  79. 					<tr>
    80. 

  80. 						<th scope="col">Constructor Attributes</th>
    81. 

  81. 						<th scope="col">Constructor Name and Description</th>
    82. 

  82. 					</tr>
    83. 

  83. 				</thead>
    84. 

  84. 				<tbody>
    85. 

  85. 					<tr>
    86. 

  86. 						<td class="attributes">{!
    87. 

  87. 							if (data.isPrivate) output += "&lt;private&gt; ";
    88. 

  88. 							if (data.isInner) output += "&lt;inner&gt; ";
    89. 

  89. 						!}&nbsp;</td>
    90. 

  90. 						<td class="nameDescription" {!if (data.comment.getTag("hilited").length){output += 'style="color: red"'}!}>
    91. 

  91. 							<div class="fixedFont">
    92. 

  92. 								<b>{+ new Link().toSymbol(data.alias).inner('constructor')+}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
    93. 

  93. 							</div>
    94. 

  94. 							<div class="description">{+resolveLinks(summarize(data.desc))+}</div>
    95. 

  95. 						</td>
    96. 

  96. 					</tr>
    97. 

  97. 				</tbody>
    98. 

  98. 			</table>
    99. 

  99. 			</if>
    100. 

  100. 

  101. <!-- ============================== properties summary ===================== -->
    102. 

  102. 			<if test="data.properties.length">
    103. 

  103. 				{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
    104. 

  104. 				<if test="ownProperties.length">
    105. 

  105. 				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}.">
    106. 

  106. 					<caption>Field Summary</caption>
    107. 

  107. 					<thead>
    108. 

  108. 						<tr>
    109. 

  109. 							<th scope="col">Field Attributes</th>
    110. 

  110. 							<th scope="col">Field Name and Description</th>
    111. 

  111. 						</tr>
    112. 

  112. 					</thead>
    113. 

  113. 					<tbody>
    114. 

  114. 					<for each="member" in="ownProperties">
    115. 

  115. 						<tr>
    116. 

  116. 							<td class="attributes">{!
    117. 

  117. 								if (member.isPrivate) output += "&lt;private&gt; ";
    118. 

  118. 								if (member.isInner) output += "&lt;inner&gt; ";
    119. 

  119. 								if (member.isStatic) output += "&lt;static&gt; ";
    120. 

  120. 								if (member.isConstant) output += "&lt;constant&gt; ";
    121. 

  121. 							!}&nbsp;</td>
    122. 

  122. 							<td class="nameDescription">
    123. 

  123. 								<div class="fixedFont">
    124. 

  124. 								<if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>
    125. 

  125. 								</div>
    126. 

  126. 								<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
    127. 

  127. 							</td>
    128. 

  128. 						</tr>
    129. 

  129. 					</for>
    130. 

  130. 					</tbody>
    131. 

  131. 				</table>
    132. 

  132. 				</if>
    133. 

  133. 				
    134. 

  134. 				<if test="data.inheritsFrom.length">
    135. 

  135. 				<dl class="inheritsList">
    136. 

  136. 				{!
    137. 

  137. 					var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
    138. 

  138. 					
    139. 

  139. 					var contributers = [];
    140. 

  140. 					borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
    141. 

  141. 					for (var i = 0, l = contributers.length; i < l; i++) {
    142. 

  142. 						output +=
    143. 

  143. 							"<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
    144. 

  144. 							+
    145. 

  145. 							"<dd>" +
    146. 

  146. 							borrowedMembers
    147. 

  147. 							.filter(
    148. 

  148. 								function($) { return $.memberOf == contributers[i] }
    149. 

  149. 							)
    150. 

  150. 							.sort(makeSortby("name"))
    151. 

  151. 							.map(
    152. 

  152. 								function($) { return new Link().toSymbol($.alias).withText($.name) }
    153. 

  153. 							)
    154. 

  154. 							.join(", ")
    155. 

  155. 							+
    156. 

  156. 							"</dd>";
    157. 

  157. 					}
    158. 

  158. 				!}
    159. 

  159. 				</dl>
    160. 

  160. 				</if>
    161. 

  161. 			</if>
    162. 

  162. 

  163. <!-- ============================== methods summary ======================== -->
    164. 

  164. 			<if test="data.methods.length">
    165. 

  165. 				{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias  && !$.isNamespace}).sort(makeSortby("name")); !}
    166. 

  166. 				<if test="ownMethods.length">
    167. 

  167. 				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}.">
    168. 

  168. 					<caption>Method Summary</caption>
    169. 

  169. 					<thead>
    170. 

  170. 						<tr>
    171. 

  171. 							<th scope="col">Method Attributes</th>
    172. 

  172. 							<th scope="col">Method Name and Description</th>
    173. 

  173. 						</tr>
    174. 

  174. 					</thead>
    175. 

  175. 					<tbody>
    176. 

  176. 					<for each="member" in="ownMethods">
    177. 

  177. 						<tr>
    178. 

  178. 							<td class="attributes">{!
    179. 

  179. 								if (member.isPrivate) output += "&lt;private&gt; ";
    180. 

  180. 								if (member.isInner) output += "&lt;inner&gt; ";
    181. 

  181. 								if (member.isStatic) output += "&lt;static&gt; ";
    182. 

  182. 							!}&nbsp;</td>
    183. 

  183. 							<td class="nameDescription">
    184. 

  184. 								<div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+}
    185. 

  185. 								</div>
    186. 

  186. 								<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
    187. 

  187. 							</td>
    188. 

  188. 						</tr>
    189. 

  189. 					</for>
    190. 

  190. 					</tbody>
    191. 

  191. 				</table>
    192. 

  192. 				</if>
    193. 

  193. 				
    194. 

  194. 				<if test="data.inheritsFrom.length">
    195. 

  195. 				<dl class="inheritsList">
    196. 

  196. 				{!
    197. 

  197. 					var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
    198. 

  198. 					var contributers = [];
    199. 

  199. 					borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
    200. 

  200. 					for (var i = 0, l = contributers.length; i < l; i++) {
    201. 

  201. 						output +=
    202. 

  202. 							"<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
    203. 

  203. 							+
    204. 

  204. 							"<dd>" +
    205. 

  205. 							borrowedMembers
    206. 

  206. 							.filter(
    207. 

  207. 								function($) { return $.memberOf == contributers[i] }
    208. 

  208. 							)
    209. 

  209. 							.sort(makeSortby("name"))
    210. 

  210. 							.map(
    211. 

  211. 								function($) { return new Link().toSymbol($.alias).withText($.name) }
    212. 

  212. 							)
    213. 

  213. 							.join(", ")
    214. 

  214. 							+
    215. 

  215. 							"</dd>";
    216. 

  216. 					}
    217. 

  217. 				
    218. 

  218. 				!}
    219. 

  219. 				</dl>
    220. 

  220. 				</if>
    221. 

  221. 			</if>
    222. 

  222. <!-- ============================== events summary ======================== -->
    223. 

  223. 			<if test="data.events.length">
    224. 

  224. 				{! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias  && !$.isNamespace}).sort(makeSortby("name")); !}
    225. 

  225. 				<if test="ownEvents.length">
    226. 

  226. 				<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}.">
    227. 

  227. 					<caption>Event Summary</caption>
    228. 

  228. 					<thead>
    229. 

  229. 						<tr>
    230. 

  230. 							<th scope="col">Event Attributes</th>
    231. 

  231. 							<th scope="col">Event Name and Description</th>
    232. 

  232. 						</tr>
    233. 

  233. 					</thead>
    234. 

  234. 					<tbody>
    235. 

  235. 					<for each="member" in="ownEvents">
    236. 

  236. 						<tr>
    237. 

  237. 							<td class="attributes">{!
    238. 

  238. 								if (member.isPrivate) output += "&lt;private&gt; ";
    239. 

  239. 								if (member.isInner) output += "&lt;inner&gt; ";
    240. 

  240. 								if (member.isStatic) output += "&lt;static&gt; ";
    241. 

  241. 							!}&nbsp;</td>
    242. 

  242. 							<td class="nameDescription">
    243. 

  243. 								<div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>{+makeSignature(member.params)+}
    244. 

  244. 								</div>
    245. 

  245. 								<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
    246. 

  246. 							</td>
    247. 

  247. 						</tr>
    248. 

  248. 					</for>
    249. 

  249. 					</tbody>
    250. 

  250. 				</table>
    251. 

  251. 				</if>
    252. 

  252. 				
    253. 

  253. 				<if test="data.inheritsFrom.length">
    254. 

  254. 				<dl class="inheritsList">
    255. 

  255. 				{!
    256. 

  256. 					var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias});
    257. 

  257. 					var contributers = [];
    258. 

  258. 					borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
    259. 

  259. 					for (var i = 0, l = contributers.length; i < l; i++) {
    260. 

  260. 						output +=
    261. 

  261. 							"<dt>Events borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
    262. 

  262. 							+
    263. 

  263. 							"<dd>" +
    264. 

  264. 							borrowedMembers
    265. 

  265. 							.filter(
    266. 

  266. 								function($) { return $.memberOf == contributers[i] }
    267. 

  267. 							)
    268. 

  268. 							.sort(makeSortby("name"))
    269. 

  269. 							.map(
    270. 

  270. 								function($) { return new Link().toSymbol($.alias).withText($.name) }
    271. 

  271. 							)
    272. 

  272. 							.join(", ")
    273. 

  273. 							+
    274. 

  274. 							"</dd>";
    275. 

  275. 					}
    276. 

  276. 				
    277. 

  277. 				!}
    278. 

  278. 				</dl>
    279. 

  279. 				</if>
    280. 

  280. 			</if>
    281. 

  281. 

  282. <!-- ============================== constructor details ==================== -->		
    283. 

  283. 			<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
    284. 

  284. 			<div class="details"><a name="constructor"> </a>
    285. 

  285. 				<div class="sectionTitle">
    286. 

  286. 					{+classType+}Detail
    287. 

  287. 				</div>
    288. 

  288. 				
    289. 

  289. 				<div class="fixedFont">{!
    290. 

  290. 					if (data.isPrivate) output += "&lt;private&gt; ";
    291. 

  291. 					if (data.isInner) output += "&lt;inner&gt; ";
    292. 

  292. 				!}
    293. 

  293. 						<b>{+ data.alias +}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
    294. 

  294. 				</div>
    295. 

  295. 				
    296. 

  296. 				<div class="description">
    297. 

  297. 					{+resolveLinks(data.desc)+}
    298. 

  298. 					<if test="data.author"><br /><i>Author: </i>{+data.author+}.</if>
    299. 

  299. 				</div>
    300. 

  300. 				
    301. 

  301. 				<if test="data.example.length">
    302. 

  302. 				<for each="example" in="data.example">
    303. 

  303. 				<pre class="code">{+example+}</pre>
    304. 

  304. 				</for>
    305. 

  305. 				</if>
    306. 

  306. 				
    307. 

  307. 				
    308. 

  308. 					<if test="data.params.length">
    309. 

  309. 						<dl class="detailList">
    310. 

  310. 						<dt class="heading">Parameters:</dt>
    311. 

  311. 						<for each="item" in="data.params">
    312. 

  312. 							<dt>
    313. 

  313. 								{+((item.type)?""+("<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type)+"}</span> ")) : "")+} <b>{+item.name+}</b>
    314. 

  314. 								<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
    315. 

  315. 							</dt>
    316. 

  316. 								<dd>{+resolveLinks(item.desc)+}</dd>
    317. 

  317. 						</for>
    318. 

  318. 						</dl>
    319. 

  319. 					</if>
    320. 

  320. 					<if test="data.deprecated">
    321. 

  321. 						<dl class="detailList">
    322. 

  322. 						<dt class="heading">Deprecated:</dt>
    323. 

  323. 						<dt>
    324. 

  324. 							{+resolveLinks(data.deprecated)+}
    325. 

  325. 						</dt>
    326. 

  326. 						</dl>
    327. 

  327. 					</if>
    328. 

  328. 					<if test="data.since">
    329. 

  329. 						<dl class="detailList">
    330. 

  330. 						<dt class="heading">Since:</dt>
    331. 

  331. 							<dd>{+ data.since +}</dd>
    332. 

  332. 						</dl>
    333. 

  333. 					</if>
    334. 

  334. 					<if test="data.exceptions.length">
    335. 

  335. 						<dl class="detailList">
    336. 

  336. 						<dt class="heading">Throws:</dt>
    337. 

  337. 						<for each="item" in="data.exceptions">
    338. 

  338. 							<dt>
    339. 

  339. 								{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
    340. 

  340. 							</dt>
    341. 

  341. 								<dd>{+resolveLinks(item.desc)+}</dd>
    342. 

  342. 						</for>
    343. 

  343. 						</dl>
    344. 

  344. 					</if>
    345. 

  345. 					<if test="data.returns.length">
    346. 

  346. 						<dl class="detailList">
    347. 

  347. 						<dt class="heading">Returns:</dt>
    348. 

  348. 						<for each="item" in="data.returns">
    349. 

  349. 								<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
    350. 

  350. 						</for>
    351. 

  351. 						</dl>
    352. 

  352. 					</if>
    353. 

  353. 					<if test="data.requires.length">
    354. 

  354. 						<dl class="detailList">
    355. 

  355. 						<dt class="heading">Requires:</dt>
    356. 

  356. 						<for each="item" in="data.requires">
    357. 

  357. 							<dd>{+ new Link().toSymbol(item) +}</dd>
    358. 

  358. 						</for>
    359. 

  359. 						</dl>
    360. 

  360. 					</if>
    361. 

  361. 					<if test="data.see.length">
    362. 

  362. 						<dl class="detailList">
    363. 

  363. 						<dt class="heading">See:</dt>
    364. 

  364. 						<for each="item" in="data.see">
    365. 

  365. 							<dd>{+ new Link().toSymbol(item) +}</dd>
    366. 

  366. 						</for>
    367. 

  367. 						</dl>
    368. 

  368. 					</if>
    369. 

  369. 

  370. 			</div>
    371. 

  371. 			</if>
    372. 

  372. 

  373. <!-- ============================== field details ========================== -->		
    374. 

  374. 			<if test="defined(ownProperties) && ownProperties.length">
    375. 

  375. 				<div class="sectionTitle">
    376. 

  376. 					Field Detail
    377. 

  377. 				</div>
    378. 

  378. 				<for each="member" in="ownProperties">
    379. 

  379. 					<a name="{+Link.symbolNameToLinkName(member)+}"> </a>
    380. 

  380. 					<div class="fixedFont">{!
    381. 

  381. 						if (member.isPrivate) output += "&lt;private&gt; ";
    382. 

  382. 						if (member.isInner) output += "&lt;inner&gt; ";
    383. 

  383. 						if (member.isStatic) output += "&lt;static&gt; ";
    384. 

  384. 						if (member.isConstant) output += "&lt;constant&gt; ";
    385. 

  385. 					!}
    386. 

  386. 					
    387. 

  387. 					<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
    388. 

  388. 					<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>
    389. 

  389. 					
    390. 

  390. 					</div>
    391. 

  391. 					<div class="description">
    392. 

  392. 						{+resolveLinks(member.desc)+}
    393. 

  393. 						<if test="member.srcFile != data.srcFile">
    394. 

  394. 							<br />
    395. 

  395. 							<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
    396. 

  396. 						</if>
    397. 

  397. 						<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
    398. 

  398. 					</div>
    399. 

  399. 					
    400. 

  400. 					<if test="member.example.length">
    401. 

  401. 					<for each="example" in="member.example">
    402. 

  402. 					<pre class="code">{+example+}</pre>
    403. 

  403. 					</for>
    404. 

  404. 					</if>
    405. 

  405. 

  406. 						<if test="member.deprecated">
    407. 

  407. 							<dl class="detailList">
    408. 

  408. 							<dt class="heading">Deprecated:</dt>
    409. 

  409. 							<dt>
    410. 

  410. 								{+ resolveLinks(member.deprecated) +}
    411. 

  411. 							</dt>
    412. 

  412. 							</dl>
    413. 

  413. 						</if>
    414. 

  414. 						<if test="member.since">
    415. 

  415. 							<dl class="detailList">
    416. 

  416. 							<dt class="heading">Since:</dt>
    417. 

  417. 								<dd>{+ member.since +}</dd>
    418. 

  418. 							</dl>
    419. 

  419. 						</if>
    420. 

  420. 						<if test="member.see.length">
    421. 

  421. 							<dl class="detailList">
    422. 

  422. 							<dt class="heading">See:</dt>
    423. 

  423. 							<for each="item" in="member.see">
    424. 

  424. 							<dd>{+ new Link().toSymbol(item) +}</dd>
    425. 

  425. 							</for>
    426. 

  426. 							</dl>
    427. 

  427. 						</if>
    428. 

  428. 						<if test="member.defaultValue">
    429. 

  429. 							<dl class="detailList">
    430. 

  430. 							<dt class="heading">Default Value:</dt>
    431. 

  431. 							<dd>
    432. 

  432. 								{+resolveLinks(member.defaultValue)+}
    433. 

  433. 							</dd>
    434. 

  434. 							</dl>
    435. 

  435. 						</if>
    436. 

  436. 

  437. 					<if test="!$member_last"><hr /></if>
    438. 

  438. 				</for>
    439. 

  439. 			</if>
    440. 

  440. 

  441. <!-- ============================== method details ========================= -->		
    442. 

  442. 			<if test="defined(ownMethods) && ownMethods.length">
    443. 

  443. 				<div class="sectionTitle">
    444. 

  444. 					Method Detail
    445. 

  445. 				</div>
    446. 

  446. 				<for each="member" in="ownMethods">
    447. 

  447. 					<a name="{+Link.symbolNameToLinkName(member)+}"> </a>
    448. 

  448. 					<div class="fixedFont">{!
    449. 

  449. 						if (member.isPrivate) output += "&lt;private&gt; ";
    450. 

  450. 						if (member.isInner) output += "&lt;inner&gt; ";
    451. 

  451. 						if (member.isStatic) output += "&lt;static&gt; ";
    452. 

  452. 					!}
    453. 

  453. 					
    454. 

  454. 					<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
    455. 

  455. 					<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+}
    456. 

  456. 					
    457. 

  457. 					</div>
    458. 

  458. 					<div class="description">
    459. 

  459. 						{+resolveLinks(member.desc)+}
    460. 

  460. 						<if test="member.srcFile != data.srcFile">
    461. 

  461. 							<br />
    462. 

  462. 							<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
    463. 

  463. 						</if>
    464. 

  464. 						<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
    465. 

  465. 					</div>
    466. 

  466. 					
    467. 

  467. 					<if test="member.example.length">
    468. 

  468. 					<for each="example" in="member.example">
    469. 

  469. 					<pre class="code">{+example+}</pre>
    470. 

  470. 					</for>
    471. 

  471. 					</if>
    472. 

  472. 					
    473. 

  473. 						<if test="member.params.length">
    474. 

  474. 							<dl class="detailList">
    475. 

  475. 							<dt class="heading">Parameters:</dt>
    476. 

  476. 							<for each="item" in="member.params">
    477. 

  477. 								<dt>
    478. 

  478. 									{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
    479. 

  479. 									<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
    480. 

  480. 								</dt>
    481. 

  481. 								<dd>{+resolveLinks(item.desc)+}</dd>
    482. 

  482. 							</for>
    483. 

  483. 							</dl>
    484. 

  484. 						</if>
    485. 

  485. 						<if test="member.deprecated">
    486. 

  486. 							<dl class="detailList">
    487. 

  487. 							<dt class="heading">Deprecated:</dt>
    488. 

  488. 							<dt>
    489. 

  489. 								{+ resolveLinks(member.deprecated) +}
    490. 

  490. 							</dt>
    491. 

  491. 							</dl>
    492. 

  492. 						</if>
    493. 

  493. 						<if test="member.since">
    494. 

  494. 							<dl class="detailList">
    495. 

  495. 							<dt class="heading">Since:</dt>
    496. 

  496. 								<dd>{+ member.since +}</dd>
    497. 

  497. 							</dl>
    498. 

  498. 							</dl>
    499. 

  499. 						</if>
    500. 

  500. 						<if test="member.exceptions.length">
    501. 

  501. 							<dl class="detailList">
    502. 

  502. 							<dt class="heading">Throws:</dt>
    503. 

  503. 							<for each="item" in="member.exceptions">
    504. 

  504. 								<dt>
    505. 

  505. 									{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
    506. 

  506. 								</dt>
    507. 

  507. 								<dd>{+resolveLinks(item.desc)+}</dd>
    508. 

  508. 							</for>
    509. 

  509. 							</dl>
    510. 

  510. 						</if>
    511. 

  511. 						<if test="member.returns.length">
    512. 

  512. 							<dl class="detailList">
    513. 

  513. 							<dt class="heading">Returns:</dt>
    514. 

  514. 							<for each="item" in="member.returns">
    515. 

  515. 								<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
    516. 

  516. 							</for>
    517. 

  517. 							</dl>
    518. 

  518. 						</if>
    519. 

  519. 						<if test="member.requires.length">
    520. 

  520. 							<dl class="detailList">
    521. 

  521. 							<dt class="heading">Requires:</dt>
    522. 

  522. 							<for each="item" in="member.requires">
    523. 

  523. 								<dd>{+ resolveLinks(item) +}</dd>
    524. 

  524. 							</for>
    525. 

  525. 							</dl>
    526. 

  526. 						</if>
    527. 

  527. 						<if test="member.see.length">
    528. 

  528. 							<dl class="detailList">
    529. 

  529. 							<dt class="heading">See:</dt>
    530. 

  530. 							<for each="item" in="member.see">
    531. 

  531. 								<dd>{+ new Link().toSymbol(item) +}</dd>
    532. 

  532. 							</for>
    533. 

  533. 							</dl>
    534. 

  534. 						</if>
    535. 

  535. 

  536. 					<if test="!$member_last"><hr /></if>
    537. 

  537. 				</for>
    538. 

  538. 			</if>
    539. 

  539. 			
    540. 

  540. <!-- ============================== event details ========================= -->		
    541. 

  541. 			<if test="defined(ownEvents) && ownEvents.length">
    542. 

  542. 				<div class="sectionTitle">
    543. 

  543. 					Event Detail
    544. 

  544. 				</div>
    545. 

  545. 				<for each="member" in="ownEvents">
    546. 

  546. 					<a name="{+Link.symbolNameToLinkName(member)+}"> </a>
    547. 

  547. 					<div class="fixedFont">{!
    548. 

  548. 						if (member.isPrivate) output += "&lt;private&gt; ";
    549. 

  549. 						if (member.isInner) output += "&lt;inner&gt; ";
    550. 

  550. 						if (member.isStatic) output += "&lt;static&gt; ";
    551. 

  551. 					!}
    552. 

  552. 					
    553. 

  553. 					<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
    554. 

  554. 					<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
    555. 

  555. 					
    556. 

  556. 					</div>
    557. 

  557. 					<div class="description">
    558. 

  558. 						{+resolveLinks(member.desc)+}
    559. 

  559. 						<if test="member.srcFile != data.srcFile">
    560. 

  560. 							<br />
    561. 

  561. 							<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
    562. 

  562. 						</if>
    563. 

  563. 						<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
    564. 

  564. 					</div>
    565. 

  565. 					
    566. 

  566. 					<if test="member.example.length">
    567. 

  567. 					<for each="example" in="member.example">
    568. 

  568. 					<pre class="code">{+example+}</pre>
    569. 

  569. 					</for>
    570. 

  570. 					</if>
    571. 

  571. 					
    572. 

  572. 						<if test="member.params.length">
    573. 

  573. 							<dl class="detailList">
    574. 

  574. 							<dt class="heading">Parameters:</dt>
    575. 

  575. 							<for each="item" in="member.params">
    576. 

  576. 								<dt>
    577. 

  577. 									{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
    578. 

  578. 									<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
    579. 

  579. 								</dt>
    580. 

  580. 								<dd>{+ resolveLinks(item.desc) +}</dd>
    581. 

  581. 							</for>
    582. 

  582. 							</dl>
    583. 

  583. 						</if>
    584. 

  584. 						<if test="member.deprecated">
    585. 

  585. 							<dl class="detailList">
    586. 

  586. 							<dt class="heading">Deprecated:</dt>
    587. 

  587. 							<dt>
    588. 

  588. 								{+ resolveLinks(member.deprecated) +}
    589. 

  589. 							</dt>
    590. 

  590. 							</dl>
    591. 

  591. 						</if>
    592. 

  592. 						<if test="member.since">
    593. 

  593. 							<dl class="detailList">
    594. 

  594. 							<dt class="heading">Since:</dt>
    595. 

  595. 								<dd>{+ member.since +}</dd>
    596. 

  596. 							</dl>
    597. 

  597. 							</dl>
    598. 

  598. 						</if>
    599. 

  599. 						<if test="member.exceptions.length">
    600. 

  600. 							<dl class="detailList">
    601. 

  601. 							<dt class="heading">Throws:</dt>
    602. 

  602. 							<for each="item" in="member.exceptions">
    603. 

  603. 								<dt>
    604. 

  604. 									{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
    605. 

  605. 								</dt>
    606. 

  606. 								<dd>{+ resolveLinks(item.desc) +}</dd>
    607. 

  607. 							</for>
    608. 

  608. 							</dl>
    609. 

  609. 						</if>
    610. 

  610. 						<if test="member.returns.length">
    611. 

  611. 							<dl class="detailList">
    612. 

  612. 							<dt class="heading">Returns:</dt>
    613. 

  613. 							<for each="item" in="member.returns">
    614. 

  614. 								<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
    615. 

  615. 							</for>
    616. 

  616. 							</dl>
    617. 

  617. 						</if>
    618. 

  618. 						<if test="member.requires.length">
    619. 

  619. 							<dl class="detailList">
    620. 

  620. 							<dt class="heading">Requires:</dt>
    621. 

  621. 							<for each="item" in="member.requires">
    622. 

  622. 								<dd>{+ resolveLinks(item) +}</dd>
    623. 

  623. 							</for>
    624. 

  624. 							</dl>
    625. 

  625. 						</if>
    626. 

  626. 						<if test="member.see.length">
    627. 

  627. 							<dl class="detailList">
    628. 

  628. 							<dt class="heading">See:</dt>
    629. 

  629. 							<for each="item" in="member.see">
    630. 

  630. 								<dd>{+ new Link().toSymbol(item) +}</dd>
    631. 

  631. 							</for>
    632. 

  632. 							</dl>
    633. 

  633. 						</if>
    634. 

  634. 

  635. 					<if test="!$member_last"><hr /></if>
    636. 

  636. 				</for>
    637. 

  637. 			</if>
    638. 

  638. 			
    639. 

  639. 			<hr />
    640. 

  640. 		</div>
    641. 

  641. 

  642. 		
    643. 

  643. <!-- ============================== footer ================================= -->
    644. 

  644. 		<div class="fineprint" style="clear:both">
    645. 

  645. 			<if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
    646. 

  646. 			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
    647. 

  647. 		</div>
    648. 

  648. 	</body>
    649. 

  649. </html>
    650. 

  650.