/branches/version1.x/templates/sweet/file.tmpl

http://jsdoc-toolkit.googlecode.com/ · Go Template · 364 lines · 332 code · 32 blank · 0 comment · 0 complexity · dd5d6272e816b922c5bc0d6aeaf6b4e4 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    2. 

  2. "http://www.w3.org/TR/html4/loose.dtd">
    3. 

  3. <html>
    4. 

  4. <head>
    5. 

  5. 	<meta http-equiv="content-type" content="text/html; charset={+(JsDoc.opt.e||'utf-8')+}">
    6. 

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

  7. 	<title>JsDoc: {+data.overview.name+}</title>
    8. 

  8. 	<link rel=stylesheet href="default.css" type="text/css" media=screen>
    9. 

  9. </head>
    10. 

  10. 

  11. <body>
    12. 

  12. 	<div class="content">
    13. 

  13. 		<div class="docs">
    14. 

  14. 		
    15. 

  15. 			<div class="sectionHead">Library: {+(data.overview.name||data.filename)+}</div>
    16. 

  16. 			<div class="section overview">
    17. 

  17. 				<div class="itemTitle">
    18. 

  18. 					Overview
    19. 

  19. 				</div>
    20. 

  20. 				<div>	
    21. 

  21. 					<div class="desc">{+data.overview.desc+}</div>
    22. 

  22. 					<div class="itemTags">
    23. 

  23. 					<ul>
    24. 

  24. 						<if test="data.source"><li>source: <a href="{+data.source+}">{+data.filename+}</a></li></if>
    25. 

  25. 					<for each="tag" in="data.overview.doc.tags">
    26. 

  26. 						<li>{+tag.title+}: {+tag.desc+}</li>
    27. 

  27. 					</for>
    28. 

  28. 					</ul>
    29. 

  29. 					</div>
    30. 

  30. 				</div>
    31. 

  31. 			</div>
    32. 

  32. 			
    33. 

  33. 			<div class="sectionHead">Constructors</div>
    34. 

  34. 			<for each="symbol" in="data.symbols">
    35. 

  35. 			<if test="symbol.is('CONSTRUCTOR') && !symbol.isStatic">
    36. 

  36. 			<div class="section constructor">
    37. 

  37. 				<div class="itemTitle">
    38. 

  38. 					<a name="{+symbol.alias+}"></a>
    39. 

  39. 					<if test="symbol.deprecated"><span class="deprecated"><del></if>
    40. 

  40. 					<if test="symbol.memberof">
    41. 

  41. 						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}({+symbol.signature()+})
    42. 

  42. 					</if>
    43. 

  43. 					<if test="!symbol.memberof">
    44. 

  44. 					{+symbol.alias+}(<span class="signature">{+symbol.signature()+}</span>)
    45. 

  45. 					</if>
    46. 

  46. 					<if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if>
    47. 

  47. 				</div>
    48. 

  48. 				
    49. 

  49. 				<if test="symbol.desc != 'undocumented'">
    50. 

  50. 					<div class="desc">{+symbol.desc+}</div>
    51. 

  51. 				</if>
    52. 

  52. 				<if test="(!symbol.desc || symbol.desc == 'undocumented') && symbol.doc.getTag('class').length">
    53. 

  53. 					<div class="desc">{+symbol.doc.getTag('class').shift().desc+}</div>
    54. 

  54. 				</if>
    55. 

  55. 				
    56. 

  56. 				<if test="symbol.doc.getTag('version').length">
    57. 

  57. 				<div>version: {+ symbol.doc.getTag('version').shift(); +}</div>
    58. 

  58. 				</if>
    59. 

  59. 				
    60. 

  60. 				<for each="example" in="symbol.doc.getTag('example')">
    61. 

  61. 					<pre class="code">{+example.desc+}</pre>
    62. 

  62. 				</for>
    63. 

  63. 				
    64. 

  64. 				<if test="symbol.params.length">
    65. 

  65. 				<div class="detailHead">parameters</div>
    66. 

  66. 				<table class="params">
    67. 

  67. 				<for each="param" in="symbol.params">
    68. 

  68. 					<tr>
    69. 

  69. 						<td class="type">
    70. 

  70. 							{+linkToType(param.type)+}
    71. 

  71. 						</td>
    72. 

  72. 						<td>
    73. 

  73. 							{+param.name+}<if test="param.isOptional"><a title="optional parameter" class="optional">?</a></if>
    74. 

  74. 							<if test="param.defaultValue != ''"><span class="optional">= {+param.defaultValue+}</span></if>
    75. 

  75. 						</td>
    76. 

  76. 						<td>
    77. 

  77. 							{+param.desc+}
    78. 

  78. 						</td> 
    79. 

  79. 					</tr>
    80. 

  80. 				</for>
    81. 

  81. 				</table>
    82. 

  82. 				</if>
    83. 

  83. 				
    84. 

  84. 				<if test="symbol.methods.length">
    85. 

  85. 				<div class="detailHead">methods</div>
    86. 

  86. 				<for each="method" in="symbol.methods">
    87. 

  87. 					<ul class="details">
    88. 

  88. 						<li><a href="#{+method.alias+}">{+method.name+}</a>({+method.signature()+})</li>
    89. 

  89. 					</ul>
    90. 

  90. 				</for>
    91. 

  91. 				</if>
    92. 

  92. 				
    93. 

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

  94. 				<div class="detailHead">properties</div>
    95. 

  95. 				<for each="property" in="symbol.properties">
    96. 

  96. 					<ul class="details">
    97. 

  97. 						<li><if test="property.type"><span class="type">{+property.type+}</span> </if><a href="#{+property.alias+}">{+property.name+}</a><if test="property.desc"> {+property.desc+}</if></li>
    98. 

  98. 					</ul>
    99. 

  99. 				</for>
    100. 

  100. 				</if>
    101. 

  101. 				
    102. 

  102. 				<if test="symbol.inherits.length || symbol.augments.length">
    103. 

  103. 					<div class="detailHead">inherits</div>
    104. 

  104. 					<for each="method" in="symbol.getInheritedMethods()">
    105. 

  105. 						<div>{+method.name+}(<span class="signature">{+method.signature()+}</span>) from {+method.memberof+}</div>
    106. 

  106. 					</for>
    107. 

  107. 				</if>
    108. 

  108. 				
    109. 

  109. 				<if test="symbol.exceptions.length">
    110. 

  110. 				<div class="detailHead">exceptions</div>
    111. 

  111. 				<table class="params">
    112. 

  112. 				<for each="ex" in="symbol.exceptions">
    113. 

  113. 					<tr>
    114. 

  114. 						<td class="type">
    115. 

  115. 						{+linkToType(ex.type)+}
    116. 

  116. 						</td>
    117. 

  117. 						<td>
    118. 

  118. 							{+ex.desc+}
    119. 

  119. 						</td> 
    120. 

  120. 					</tr>
    121. 

  121. 				</for>
    122. 

  122. 				</table>
    123. 

  123. 				</if>
    124. 

  124. 			</div>
    125. 

  125. 			</if>
    126. 

  126. 			</for>
    127. 

  127. 			
    128. 

  128. 			<div class="sectionHead">Namespaces</div>
    129. 

  129. 			<for each="symbol" in="data.symbols">
    130. 

  130. 			<if test="symbol.is('CONSTRUCTOR') && symbol.isStatic">
    131. 

  131. 			<div class="section object">
    132. 

  132. 				<div class="itemTitle">
    133. 

  133. 					<a name="{+symbol.alias+}"></a>
    134. 

  134. 					<if test="symbol.deprecated"><span class="deprecated"><del></if>
    135. 

  135. 					<if test="symbol.memberof">
    136. 

  136. 						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}({+symbol.signature()+})
    137. 

  137. 					</if>
    138. 

  138. 					<if test="!symbol.memberof">
    139. 

  139. 					{+symbol.alias+}
    140. 

  140. 					</if>
    141. 

  141. 					<if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if>
    142. 

  142. 				</div>
    143. 

  143. 				
    144. 

  144. 				<if test="symbol.desc != 'undocumented'">
    145. 

  145. 					<div class="desc">{+symbol.desc+}</div>
    146. 

  146. 				</if>
    147. 

  147. 				<if test="(!symbol.desc || symbol.desc == 'undocumented') && symbol.doc.getTag('class').length">
    148. 

  148. 					<div class="desc">{+symbol.doc.getTag('class').shift().desc+}</div>
    149. 

  149. 				</if>
    150. 

  150. 				
    151. 

  151. 				<if test="symbol.doc.getTag('version').length">
    152. 

  152. 				<div>version: {+ symbol.doc.getTag('version').shift(); +}</div>
    153. 

  153. 				</if>
    154. 

  154. 				
    155. 

  155. 				<for each="example" in="symbol.doc.getTag('example')">
    156. 

  156. 					<pre class="code">{+example.desc+}</pre>
    157. 

  157. 				</for>
    158. 

  158. 				
    159. 

  159. 				<if test="symbol.params.length">
    160. 

  160. 				<div class="detailHead">parameters</div>
    161. 

  161. 				<table class="params">
    162. 

  162. 				<for each="param" in="symbol.params">
    163. 

  163. 					<tr>
    164. 

  164. 						<td class="type">
    165. 

  165. 							{+linkToType(param.type)+}
    166. 

  166. 						</td>
    167. 

  167. 						<td>
    168. 

  168. 							{+param.name+}<if test="param.isOptional"><a title="optional parameter" class="optional">?</a></if>
    169. 

  169. 							<if test="param.defaultValue != ''"><span class="optional">= {+param.defaultValue+}</span></if>
    170. 

  170. 						</td>
    171. 

  171. 						<td>
    172. 

  172. 							{+param.desc+}
    173. 

  173. 						</td> 
    174. 

  174. 					</tr>
    175. 

  175. 				</for>
    176. 

  176. 				</table>
    177. 

  177. 				</if>
    178. 

  178. 				
    179. 

  179. 				<if test="symbol.methods.length">
    180. 

  180. 				<div class="detailHead">methods</div>
    181. 

  181. 				<for each="method" in="symbol.methods">
    182. 

  182. 					<ul class="details">
    183. 

  183. 						<li><a href="#{+method.alias+}">{+method.name+}</a>({+method.signature()+})</li>
    184. 

  184. 					</ul>
    185. 

  185. 				</for>
    186. 

  186. 				</if>
    187. 

  187. 				
    188. 

  188. 				<if test="symbol.properties.length">
    189. 

  189. 				<div class="detailHead">properties</div>
    190. 

  190. 				<for each="property" in="symbol.properties">
    191. 

  191. 					<ul class="details">
    192. 

  192. 						<li><if test="property.type"><span class="type">{+property.type+}</span> </if><a href="#{+property.alias+}">{+property.name+}</a></li>
    193. 

  193. 					</ul>
    194. 

  194. 				</for>
    195. 

  195. 				</if>
    196. 

  196. 				
    197. 

  197. 				<if test="symbol.inherits.length || symbol.augments.length">
    198. 

  198. 					<div class="detailHead">inherits</div>
    199. 

  199. 					<for each="method" in="symbol.getInheritedMethods()">
    200. 

  200. 						<div>{+method.name+}(<span class="signature">{+method.signature()+}</span>) from {+method.memberof+}</div>
    201. 

  201. 					</for>
    202. 

  202. 				</if>
    203. 

  203. 				
    204. 

  204. 				<if test="symbol.exceptions.length">
    205. 

  205. 				<div class="detailHead">exceptions</div>
    206. 

  206. 				<table class="params">
    207. 

  207. 				<for each="ex" in="symbol.exceptions">
    208. 

  208. 					<tr>
    209. 

  209. 						<td class="type">
    210. 

  210. 							{+linkToType(ex.type)+}
    211. 

  211. 						</td>
    212. 

  212. 						<td>
    213. 

  213. 							{+ex.desc+}
    214. 

  214. 						</td> 
    215. 

  215. 					</tr>
    216. 

  216. 				</for>
    217. 

  217. 				</table>
    218. 

  218. 				</if>
    219. 

  219. 			</div>
    220. 

  220. 			</if>
    221. 

  221. 			</for>
    222. 

  222. 			
    223. 

  223. 			<div class="sectionHead">Functions</div>
    224. 

  224. 			<for each="symbol" in="data.symbols">
    225. 

  225. 			<if test="symbol.is('FUNCTION')">
    226. 

  226. 			<div class="section function">
    227. 

  227. 				<div class="itemTitle">
    228. 

  228. 					<a name="{+symbol.alias+}"></a>
    229. 

  229. 					<if test="symbol.deprecated"><span class="deprecated"><del></if>
    230. 

  230. 					<if test="symbol.memberof">
    231. 

  231. 						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}(<span class="signature">{+symbol.signature()+}</span>)
    232. 

  232. 					</if>
    233. 

  233. 					<if test="!symbol.memberof">
    234. 

  234. 					{+symbol.alias+}(<span class="signature">{+symbol.signature()+}</span>)
    235. 

  235. 					</if>
    236. 

  236. 					<if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if>
    237. 

  237. 				</div>
    238. 

  238. 				
    239. 

  239. 				<if test="symbol.desc != 'undocumented'">
    240. 

  240. 					<div class="desc">{+symbol.desc+}</div>
    241. 

  241. 				</if>
    242. 

  242. 

  243. 				<if test="symbol.doc.getTag('since').length">
    244. 

  244. 				<div>since: {+ symbol.doc.getTag('since').shift(); +}</div>
    245. 

  245. 				</if>
    246. 

  246. 				
    247. 

  247. 				<for each="example" in="symbol.doc.getTag('example')">
    248. 

  248. 					<pre class="code">{+example.desc+}</pre>
    249. 

  249. 				</for>
    250. 

  250. 				
    251. 

  251. 				<if test="symbol.params.length">
    252. 

  252. 				<div class="detailHead">parameters</div>
    253. 

  253. 				<table class="params">
    254. 

  254. 				<for each="param" in="symbol.params">
    255. 

  255. 					<tr>
    256. 

  256. 						<td class="type">
    257. 

  257. 							{+linkToType(param.type)+}
    258. 

  258. 						</td>
    259. 

  259. 						<td>
    260. 

  260. 							{+param.name+}<if test="param.isOptional"><a title="optional parameter" class="optional">?</a></if>
    261. 

  261. 							<if test="param.defaultValue != ''"><span class="optional">= {+param.defaultValue+}</span></if>
    262. 

  262. 						</td>
    263. 

  263. 						<td>
    264. 

  264. 							{+param.desc+}
    265. 

  265. 						</td> 
    266. 

  266. 					</tr>
    267. 

  267. 				</for>
    268. 

  268. 				</table>
    269. 

  269. 				</if>
    270. 

  270. 				
    271. 

  271. 				<if test="symbol.returns.length">
    272. 

  272. 				<div class="detailHead">returns</div>
    273. 

  273. 				<table class="params">
    274. 

  274. 				<for each="ret" in="symbol.returns">
    275. 

  275. 					<tr>
    276. 

  276. 						<td class="type">
    277. 

  277. 							{+linkToType(ret.type)+}
    278. 

  278. 						</td>
    279. 

  279. 						<td>
    280. 

  280. 							{+ret.desc+}
    281. 

  281. 						</td> 
    282. 

  282. 					</tr>
    283. 

  283. 				</for>
    284. 

  284. 				</table>
    285. 

  285. 				</if>
    286. 

  286. 				
    287. 

  287. 				<if test="symbol.exceptions.length">
    288. 

  288. 				<div class="detailHead">exceptions</div>
    289. 

  289. 				<table class="params">
    290. 

  290. 				<for each="ex" in="symbol.exceptions">
    291. 

  291. 					<tr>
    292. 

  292. 						<td class="type">
    293. 

  293. 							{+linkToType(ex.type)+}
    294. 

  294. 						</td>
    295. 

  295. 						<td>
    296. 

  296. 							{+ex.desc+}
    297. 

  297. 						</td> 
    298. 

  298. 					</tr>
    299. 

  299. 				</for>
    300. 

  300. 				</table>
    301. 

  301. 				</if>
    302. 

  302. 			</div>
    303. 

  303. 			</if>
    304. 

  304. 			</for>
    305. 

  305. 			
    306. 

  306. 			<div class="sectionHead">Objects</div>
    307. 

  307. 			<for each="symbol" in="data.symbols">
    308. 

  308. 			<if test="symbol.is('OBJECT')">
    309. 

  309. 			<div class="section object">
    310. 

  310. 				<div class="itemTitle">
    311. 

  311. 					<a name="{+symbol.alias+}"></a>
    312. 

  312. 					<if test="symbol.type">
    313. 

  313. 					<span class="type">{+symbol.type+}</span>
    314. 

  314. 					</if>
    315. 

  315. 					<if test="symbol.deprecated"><span class="deprecated"><del></if>
    316. 

  316. 					<if test="symbol.memberof">
    317. 

  317. 						<i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}
    318. 

  318. 					</if>
    319. 

  319. 					<if test="!symbol.memberof">
    320. 

  320. 						{+symbol.alias+}
    321. 

  321. 					</if>
    322. 

  322. 					<if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if>
    323. 

  323. 				</div>
    324. 

  324. 				
    325. 

  325. 				<if test="symbol.desc != 'undocumented'">
    326. 

  326. 					<div class="desc">{+symbol.desc+}</div>
    327. 

  327. 				</if>
    328. 

  328. 				
    329. 

  329. 				<if test="symbol.doc.getTag('since').length">
    330. 

  330. 				<div>since: {+ symbol.doc.getTag('since').shift(); +}</div>
    331. 

  331. 				</if>
    332. 

  332. 				
    333. 

  333. 				<for each="example" in="symbol.doc.getTag('example')">
    334. 

  334. 					<pre class="code">{+example.desc+}</pre>
    335. 

  335. 				</for>
    336. 

  336. 				
    337. 

  337. 				<if test="symbol.properties.length">
    338. 

  338. 				<div class="detailHead">properties</div>
    339. 

  339. 				<table class="params">
    340. 

  340. 				<for each="property" in="symbol.properties">
    341. 

  341. 					<tr>
    342. 

  342. 						<td class="type">
    343. 

  343. 							{+linkToType(property.type)+}
    344. 

  344. 						</td>
    345. 

  345. 						<td>
    346. 

  346. 							{+property.name+}
    347. 

  347. 						</td>
    348. 

  348. 						<td>
    349. 

  349. 							{+property.desc+}
    350. 

  350. 						</td> 
    351. 

  351. 					</tr>
    352. 

  352. 				</for>
    353. 

  353. 				</table>
    354. 

  354. 				</if>
    355. 

  355. 			</div>
    356. 

  356. 			</if>
    357. 

  357. 			</for>
    358. 

  358. 		</div>
    359. 

  359. 	</div>
    360. 

  360. 	<div class="finePrint">
    361. 

  361. 	Generated by <a href="http://jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> {+JsDoc.VERSION+} on {+new Date().toUTCString()+}.
    362. 

  362. 	</div>
    363. 

  363. </body>
    364. 

  364. </html>
    365.