/tags/jsdoc_toolkit-1.3.3/templates/sunny/class.tmpl

http://jsdoc-toolkit.googlecode.com/ · Go Template · 384 lines · 352 code · 32 blank · 0 comment · 0 complexity · 0596247f35470589cc053bfe255a7aa9 MD5 · raw file 

    

  1. {!
    2. 

  2. function byName(a, b) {
    3. 

  3. 	if (a.name != undefined && b.name != undefined) {
    4. 

  4. 		a = a.name.toLowerCase();
    5. 

  5. 		b = b.name.toLowerCase();
    6. 

  6. 		if (a < b) return -1;
    7. 

  7. 		if (a > b) return 1;
    8. 

  8. 		return 0;
    9. 

  9. 	}
    10. 

  10. }
    11. 

  11. 

  12. function summarize(desc) {
    13. 

  13. 	if (typeof desc != "undefined")
    14. 

  14. 		return desc.match(/([\w\W]+?\.)[^a-z0-9]/i)? RegExp.$1 : desc;
    15. 

  15. }
    16. 

  16. 

  17. thisClass = data[0];
    18. 

  18. !}
    19. 

  19. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    20. 

  20. 	"http://www.w3.org/TR/html4/loose.dtd">
    21. 

  21. <html>
    22. 

  22. <head>
    23. 

  23. 	<meta http-equiv="content-type" content="text/html; charset=utf-8">
    24. 

  24. 	<title>JsDoc: {+thisClass.alias+}</title>
    25. 

  25. 	<style type="text/css">
    26. 

  26. 		body { background-color: #FFFFFF; }
    27. 

  27. 		.TableHeadingColor { background: #CCCCFF; }
    28. 

  28. 		.TableSubHeadingColor { background: #EEEEFF; }
    29. 

  29. 		.TableRowColor { background: #FFFFFF; }
    30. 

  30. 		
    31. 

  31. 		.FrameTitleFont
    32. 

  32. 		{
    33. 

  33. 			font-size: 10pts;
    34. 

  34. 			font-family: Helvetica, Arial, san-serif;
    35. 

  35. 		}
    36. 

  36. 		
    37. 

  37. 		.FrameHeadingFont
    38. 

  38. 		{
    39. 

  39. 			font-size: 10pts;
    40. 

  40. 			font-family: Helvetica, Arial, san-serif;
    41. 

  41. 		}
    42. 

  42. 		
    43. 

  43. 		.FrameItemFont
    44. 

  44. 		{
    45. 

  45. 			font-size: 10pts;
    46. 

  46. 			font-family: Helvetica, Arial, san-serif;
    47. 

  47. 		}
    48. 

  48. 		
    49. 

  49. 		.NavBar
    50. 

  50. 		{
    51. 

  51. 			font-family: Arial, Helvetica, sans-serif;
    52. 

  52. 			background-color: #FFFFFF;
    53. 

  53. 		}
    54. 

  54. 		
    55. 

  55. 		.jsdoc_ctime
    56. 

  56. 		{
    57. 

  57. 			font-family: Arial, Helvetica, sans-serif;
    58. 

  58. 			font-size: 9pt;
    59. 

  59. 			text-align: right;
    60. 

  60. 		}
    61. 

  61. 	</style>
    62. 

  62. </head>
    63. 

  63. 

  64. <body>
    65. 

  65. 

  66. <table style="width: 100%">
    67. 

  67. <tr>
    68. 

  68. <td class="NavBar" valign="top"><font size="-2">SUMMARY:&nbsp;<a href="#field_summary">FIELD</a>&nbsp;|&nbsp;<a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;<a href="#method_summary">METHOD</a></font></td>
    69. 

  69. <td class="NavBar" valign="top"><font size="-2">DETAIL:&nbsp;<a href="#field_detail">FIELD</a>&nbsp;|&nbsp;<a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;<a href="#method_detail">METHOD</a></font></td>
    70. 

  70. </tr>
    71. 

  71. </table>
    72. 

  72. 

  73. <hr>
    74. 

  74. 

  75. <h2><if test="thisClass.isStatic">Static </if>Class {+thisClass.alias+}</h2>
    76. 

  76. 

  77. <if test="thisClass.augments && thisClass.augments.length">
    78. 

  78. 	Extends<for each="augment" in="thisClass.augments"> <a href="{+augment+}.html">{+augment+}</a></for>.<br/>
    79. 

  79. </if>
    80. 

  80. <if test="thisClass.source"><i>Defined in <a href="{+thisClass.source+}">{+thisClass.filename+}</a></i></if>
    81. 

  81. <if test="thisClass.classDesc"><p>{+thisClass.classDesc+}</p></if>
    82. 

  82. <if test="thisClass.doc">
    83. 

  83. <for each="author" in="thisClass.doc.getTag('author')">
    84. 

  84. <b>Author:</b> {+author+}<br/>
    85. 

  85. </for>
    86. 

  86. <for each="version" in="thisClass.doc.getTag('version')">
    87. 

  87. <b>Version:</b> {+version+}<br/>
    88. 

  88. </for>
    89. 

  89. </if>
    90. 

  90. <hr>
    91. 

  91. 

  92. <!-- =========== FIELD SUMMARY =========== -->
    93. 

  93. <if test="thisClass.properties.length">
    94. 

  94. <a name="field_summary"> </a> 
    95. 

  95. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    96. 

  96. 	<tr bgcolor="#CCCCFF" class="TableHeadingColor">
    97. 

  97. 		<td colspan=2>
    98. 

  98. 			<font size="+2"> <b>Field Summary</b></font>
    99. 

  99. 		</td>
    100. 

  100. 	</tr>
    101. 

  101. 	<for each="property" in="thisClass.properties.sort(byName)">
    102. 

  102. 		<tr bgcolor="white" class="TableRowColor">
    103. 

  103. 			<td align="right" valign="top" width="1%">
    104. 

  104. 				<font size="-1"><code><if test="property.isPrivate">&lt;private&gt;&nbsp;</if><if test="property.isStatic||!property.memberof">&lt;static&gt;&nbsp;</if>{+(property.type||"object")+}</code></font>
    105. 

  105. 			</td>
    106. 

  106. 			<td>
    107. 

  107. 				<code><b><a href="#{+property.name+}">{+property.name+}</a></b></code> 
    108. 

  108. 				<br>
    109. 

  109. 				&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{+summarize(property.desc)+}
    110. 

  110. 			</td>
    111. 

  111. 		</tr>
    112. 

  112. 	</for>
    113. 

  113. </table>
    114. 

  114. &nbsp;
    115. 

  115. </if>
    116. 

  116. <!-- =========== END FIELD SUMMARY =========== -->
    117. 

  117. 

  118. <if test="!thisClass.isStatic">
    119. 

  119. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    120. 

  120. <a name="constructor_summary"> </a>
    121. 

  121. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    122. 

  122. <tr bgcolor="#CCCCFF" class="TableHeadingColor">
    123. 

  123. 	<td colspan=2><font size="+2"><b>Constructor Summary</b></font></td>
    124. 

  124. </tr>
    125. 

  125. <for each="cn" in="data">
    126. 

  126. 	<tr bgcolor="white" class="TableRowColor">
    127. 

  127. 	   <td>
    128. 

  128. 	
    129. 

  129. 		<code>
    130. 

  130. 		<b><a href="#{+cn.name+}">{+cn.alias+}</a></b>({+cn.signature()+})
    131. 

  131. 		</code>
    132. 

  132. 		  <br>
    133. 

  133. 		  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    134. 

  134. 		  {+summarize(cn.desc)+}
    135. 

  135. 		  </td>
    136. 

  136. 	</tr>
    137. 

  137. </for>
    138. 

  138. </table>
    139. 

  139. &nbsp;
    140. 

  140. <!-- ======== END CONSTRUCTOR SUMMARY ======== -->
    141. 

  141. </if>
    142. 

  142. 

  143. <!-- ========== METHOD SUMMARY =========== -->
    144. 

  144. <if test="thisClass.methods.length">
    145. 

  145. <a name="method_summary"> </a> 
    146. 

  146. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    147. 

  147. 	<tr bgcolor="#CCCCFF" class="TableHeadingColor">
    148. 

  148. 		<td colspan=2>
    149. 

  149. 			<font size="+2"> <b>Method Summary</b></font>
    150. 

  150. 		</td>
    151. 

  151. 	</tr>
    152. 

  152. 	<for each="method" in="thisClass.methods.sort(byName)">
    153. 

  153. 		<tr bgcolor="white" class="TableRowColor">
    154. 

  154. 			<td align="right" valign="top" width="1%">
    155. 

  155. 				<font size="-1"><code><if test="method.isPrivate">&lt;private&gt;&nbsp;</if><if test="method.isStatic||!method.memberof">&lt;static&gt; </if><if test="method.returns.length">
    156. 

  156. 				<for each="ret" in="method.returns">&nbsp;{+ret.type+}</for>
    157. 

  157. 				</if></code></font> 
    158. 

  158. 			</td>
    159. 

  159. 			<td>
    160. 

  160. 				<code> <b> <a href="#{+method.name+}">{+method.name+}</a></b>({+method.signature()+}) </code> 
    161. 

  161. 				<br>
    162. 

  162. 				&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; {+summarize(method.desc)+}
    163. 

  163.  
    164. 

  164. 			</td>
    165. 

  165. 		</tr>
    166. 

  166. 	</for>
    167. 

  167. </table>
    168. 

  168. &nbsp;
    169. 

  169. </if>
    170. 

  170. <!-- ========== EVENT SUMMARY =========== -->
    171. 

  171. <if test="thisClass.events">
    172. 

  172. <if test="thisClass.events.length">
    173. 

  173. <a name="event_summary"> </a> 
    174. 

  174. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    175. 

  175. 	<tr bgcolor="#CCCCFF" class="TableHeadingColor">
    176. 

  176. 		<td colspan=2>
    177. 

  177. 			<font size="+2"> <b>Event Summary</b></font>
    178. 

  178. 		</td>
    179. 

  179. 	</tr>
    180. 

  180. 	<for each="event" in="thisClass.events.sort(byName)">
    181. 

  181. 		<tr bgcolor="white" class="TableRowColor">
    182. 

  182. 			<td align="right" valign="top" width="1%">
    183. 

  183. 				<font size="-1"><code><if test="event.isPrivate">&lt;private&gt;&nbsp;</if>
    184. 

  184.                 
    185. 

  185.                 <if test="event.returns.length">
    186. 

  186. 				  <for each="ret" in="event.returns">&nbsp;{+ret.type+}</for>
    187. 

  187.                 </if>
    188. 

  188.                 <if test="event.returns.length==0">
    189. 

  189.                   void
    190. 

  190. 				</if></code></font> 
    191. 

  191. 			</td>
    192. 

  192. 			<td>
    193. 

  193. 				<code> <b> <a href="#{+event.name+}">{+event.name+}</a></b>({+event.signature()+}) </code> 
    194. 

  194. 				<br>
    195. 

  195. 				&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; {+summarize(event.desc)+}
    196. 

  196.  
    197. 

  197. 			</td>
    198. 

  198. 		</tr>
    199. 

  199. 	</for>
    200. 

  200. </table>
    201. 

  201. &nbsp;
    202. 

  202. </if>
    203. 

  203. </if>
    204. 

  204. <!-- ========== INHERITED METHODS SUMMARY =========== -->
    205. 

  205. <if test="thisClass.inherited">
    206. 

  206. 	<table border="1" cellpadding="3" cellspacing="0" width="100%">
    207. 

  207. 		<for each="className" in="keys(thisClass.inherited)">
    208. 

  208. 		<tr bgcolor="#EEEEFF" class="TableSubHeadingColor">
    209. 

  209. 			<td>
    210. 

  210. 				<b>Methods inherited from class <a href="{+className+}.html">{+className+}</a></b>
    211. 

  211. 			</td>
    212. 

  212. 		</tr>
    213. 

  213. 		<for each="method" in="thisClass.inherited[className]">
    214. 

  214. 			<tr bgcolor="#EEEEFF" class="TableSubHeadingColor">
    215. 

  215. 				<td>
    216. 

  216. 				<a href="{+method.memberof+}.html#{+method.name+}">{+method.name+}</a>({+method.signature()+})
    217. 

  217. 				</td>
    218. 

  218. 			</tr>
    219. 

  219. 		</for>
    220. 

  220. 		</for>
    221. 

  221. 	</table>
    222. 

  222. 	<br/>
    223. 

  223. </if>
    224. 

  224. <br/>
    225. 

  225. 

  226. <!-- ========== END INHERITED METHODS SUMMARY =========== -->
    227. 

  227. 

  228. <!-- ============ FIELD DETAIL START ========= -->
    229. 

  229. <if test="thisClass.properties.length">
    230. 

  230. <a name="field_detail"> </a> 
    231. 

  231. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    232. 

  232. 	<tr bgcolor="#CCCCFF" class="TableHeadingColor">
    233. 

  233. 		<td colspan=1>
    234. 

  234. 			<font size="+2"> <b>Field Detail</b></font> 
    235. 

  235. 		</td>
    236. 

  236. 	</tr>
    237. 

  237. </table>
    238. 

  238. 

  239. <for each="property" in="thisClass.properties.sort(byName)">
    240. 

  240. 	<!-- One single method detail entry -->
    241. 

  241. 	<a name="{+property.name+}">
    242. 

  242. 	<!-- -->
    243. 

  243. 	</a> <h3>{+property.name+}</h3>
    244. 

  244. 		<pre><if test="property.isPrivate">&lt;private&gt;&nbsp;</if><if test="property.isStatic||!property.memberof">&lt;static&gt;&nbsp;</if>{+(property.type||"object")+} <b>{+property.name+}</b></pre> 
    245. 

  245. 	<ul>
    246. 

  246. 		{+property.desc+}
    247. 

  247. 	</ul>
    248. 

  248. 	<hr>
    249. 

  249. </for>
    250. 

  250. </if>
    251. 

  251. <!-- ============ FIELD DETAIL END ========== -->
    252. 

  252. 

  253. <if test="!thisClass.isStatic">
    254. 

  254. <!-- ========= CONSTRUCTOR DETAIL START ======== -->
    255. 

  255. <a name="constructor_detail"> </a>
    256. 

  256. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    257. 

  257.    <tr bgcolor="#CCCCFF" class="TableHeadingColor">
    258. 

  258.       <td colspan=1>
    259. 

  259.       <font size="+2"><b>Constructor Detail</b></font>
    260. 

  260.       </td>
    261. 

  261.    </tr>
    262. 

  262. 

  263. </table>
    264. 

  264. 

  265. <a name="{+thisClass.name+}"> </a>
    266. 

  266. <h3>{+thisClass.alias+}</h3>
    267. 

  267. <for each="cn" in="data">
    268. 

  268. 	<pre><b>{+cn.alias+}</b>({+cn.signature()+})</pre>
    269. 

  269. 	<ul>
    270. 

  270. 	   {+cn.desc+}
    271. 

  271. 	</ul>
    272. 

  272. 	
    273. 

  273. 	<!-- PARAMETERS START -->
    274. 

  274. 	<if test="cn.params.length">
    275. 

  275. 	<ul>
    276. 

  276. 		<b>Parameters:</b>
    277. 

  277. 		<for each="param" in="cn.params">
    278. 

  278. 		<ul>
    279. 

  279. 			<code><if test="param.type"><i>{+param.type+}</i>&nbsp;</if>{+param.name+}</code><if test="param.desc"> - {+param.desc+}</if> 
    280. 

  280. 		</ul>
    281. 

  281. 		</for>
    282. 

  282. 	</ul>
    283. 

  283. 	</if>
    284. 

  284. 	<!-- PARAMETERS END -->
    285. 

  285. </for>
    286. 

  286. <hr/>
    287. 

  287. <!-- END ADDITIONAL ATTRIBUTES  -->
    288. 

  288. <!-- ========= CONSTRUCTOR DETAIL END ======== -->
    289. 

  289. </if>
    290. 

  290. 

  291. <!-- ============ METHOD DETAIL START ======= -->
    292. 

  292. <if test="thisClass.methods.length">
    293. 

  293. <a name="method_detail"> </a> 
    294. 

  294. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    295. 

  295. 	<tr bgcolor="#CCCCFF" class="TableHeadingColor">
    296. 

  296. 		<td colspan=1>
    297. 

  297. 			<font size="+2"> <b>Method Detail</b></font> 
    298. 

  298. 		</td>
    299. 

  299. 	</tr>
    300. 

  300. </table>
    301. 

  301. 

  302. <for each="method" in="thisClass.methods.sort(byName)">
    303. 

  303. 	<a name="{+method.name+}"> </a> <h3>{+method.name+}</h3>
    304. 

  304. 		<pre><if test="method.isPrivate">&lt;private&gt;&nbsp;</if><if test="method.isStatic||!method.memberof">&lt;static&gt;&nbsp;</if><if test="method.returns.length"><for each="ret" in="method.returns">{+ret.type+}&nbsp;</for></if><b>{+method.name+}</b>({+method.signature()+})</pre> 
    305. 

  305. 	<ul>
    306. 

  306. 		{+method.desc+}
    307. 

  307. 	</ul>
    308. 

  308. 	<!-- METHOD PARAMETERS START -->
    309. 

  309. 	<if test="method.params.length"><ul>
    310. 

  310. 		<b>Parameters:</b><for each="param" in="method.params">
    311. 

  311. 		<ul>
    312. 

  312. 			<code><if test="param.type"><i>{+param.type+}</i>&nbsp;</if>{+param.name+} </code><if test="param.desc"> - {+param.desc+}</if> 
    313. 

  313. 		</ul></for>
    314. 

  314. 	</ul></if>
    315. 

  315. 	<!-- METHOD PARAMETERS END -->
    316. 

  316. 	<!-- ADDITIONAL ATTRIBUTES START -->
    317. 

  317. 	<if test="method.returns.length"><ul>
    318. 

  318. 		<b>Returns:</b><for each="ret" in="method.returns">
    319. 

  319. 		<ul>
    320. 

  320. 			<code><if test="ret.type"><i>{+ret.type+}</i>&nbsp;</if></code>{+ret.desc+} 
    321. 

  321. 		</ul></for>
    322. 

  322. 	</ul></if>
    323. 

  323. 	<if test="method.exceptions.length"><ul>
    324. 

  324. 		<b>Throws:</b><for each="ex" in="method.exceptions">
    325. 

  325. 		<ul>
    326. 

  326. 			<code>{+ex.type+}</code> {+ex.desc+} 
    327. 

  327. 		</ul></for>
    328. 

  328. 	</ul></if>
    329. 

  329. 	<!-- ADDITIONAL ATTRIBUTES  END -->
    330. 

  330. 	<hr>
    331. 

  331. </for>
    332. 

  332. </if>
    333. 

  333. <!-- ============ METHOD DETAIL END ========== -->
    334. 

  334. 

  335. 

  336. 

  337. <!-- ============ EVENT DETAIL START ======= -->
    338. 

  338. <if test="thisClass.events">
    339. 

  339. <if test="thisClass.events.length">
    340. 

  340. <a name="method_detail"> </a> 
    341. 

  341. <table border="1" cellpadding="3" cellspacing="0" width="100%">
    342. 

  342. 	<tr bgcolor="#CCCCFF" class="TableHeadingColor">
    343. 

  343. 		<td colspan=1>
    344. 

  344. 			<font size="+2"> <b>Event Detail</b></font> 
    345. 

  345. 		</td>
    346. 

  346. 	</tr>
    347. 

  347. </table>
    348. 

  348. 

  349. <for each="event" in="thisClass.events.sort(byName)">
    350. 

  350. 	<a name="{+event.name+}"> </a> <h3>{+event.name+}</h3>
    351. 

  351. 		<pre><if test="event.isPrivate">&lt;private&gt;&nbsp;</if><if test="event.isStatic||!event.memberof">&lt;static&gt;&nbsp;</if><if test="event.returns.length"><for each="ret" in="event.returns">{+ret.type+}&nbsp;</for></if><b>{+event.name+}</b>({+event.signature()+})</pre> 
    352. 

  352. 	<ul>
    353. 

  353. 		{+event.desc+}
    354. 

  354. 	</ul>
    355. 

  355. 	<!-- EVENT PARAMETERS START -->
    356. 

  356. 	<if test="event.params.length"><ul>
    357. 

  357. 		<b>Parameters:</b><for each="param" in="event.params">
    358. 

  358. 		<ul>
    359. 

  359. 			<code><if test="param.type"><i>{+param.type+}</i>&nbsp;</if>{+param.name+} </code><if test="param.desc"> - {+param.desc+}</if> 
    360. 

  360. 		</ul></for>
    361. 

  361. 	</ul></if>
    362. 

  362. 	<!-- EVENT PARAMETERS END -->
    363. 

  363. 	<!-- ADDITIONAL ATTRIBUTES START -->
    364. 

  364. 	<if test="event.returns.length"><ul>
    365. 

  365. 		<b>Returns:</b><for each="ret" in="event.returns">
    366. 

  366. 		<ul>
    367. 

  367. 			<code><if test="ret.type"><i>{+ret.type+}</i>&nbsp;</if></code>{+ret.desc+} 
    368. 

  368. 		</ul></for>
    369. 

  369. 	</ul></if>
    370. 

  370. 	<if test="event.exceptions.length"><ul>
    371. 

  371. 		<b>Throws:</b><for each="ex" in="event.exceptions">
    372. 

  372. 		<ul>
    373. 

  373. 			<code>{+ex.type+}</code> {+ex.desc+} 
    374. 

  374. 		</ul></for>
    375. 

  375. 	</ul></if>
    376. 

  376. 	<!-- ADDITIONAL ATTRIBUTES  END -->
    377. 

  377. 	<hr>
    378. 

  378. </for>
    379. 

  379. </if>
    380. 

  380. </if>
    381. 

  381. <!-- ============ EVENT DETAIL END ========== -->
    382. 

  382. <div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoctoolkit.org/" target="_parent">JsDoc Toolkit</a> {+JsDoc.VERSION+} on {+new Date()+}</div>
    383. 

  383. </body>
    384. 

  384. </html>
    385.