/tags/jsdoc_toolkit-1.3.3/templates/sweet/file.tmpl

http://jsdoc-toolkit.googlecode.com/ · Go Template · 247 lines · 226 code · 21 blank · 0 comment · 0 complexity · ae0dd0861d6b8f079ba74ccf5486aff7 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=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')">
    36. 

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

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

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

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

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

  41. 					</if>
    42. 

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

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

  44. 					</if>
    45. 

  45. 				</div>
    46. 

  46. 				
    47. 

  47. 				<if test="symbol.desc != 'undocumented'">
    48. 

  48. 					<div class="desc">{+symbol.desc+}</div>
    49. 

  49. 				</if>
    50. 

  50. 				
    51. 

  51. 				<for each="example" in="symbol.doc.getTag('example')">
    52. 

  52. 					<pre class="code">{+example.desc+}</pre>
    53. 

  53. 				</for>
    54. 

  54. 				
    55. 

  55. 				<if test="symbol.params.length">
    56. 

  56. 				<div class="detailHead">parameters</div>
    57. 

  57. 				<table class="params">
    58. 

  58. 				<for each="param" in="symbol.params">
    59. 

  59. 					<tr>
    60. 

  60. 						<td class="type">
    61. 

  61. 							{+param.type+}
    62. 

  62. 						</td>
    63. 

  63. 						<td>
    64. 

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

  65. 						</td>
    66. 

  66. 						<td>
    67. 

  67. 							{+param.desc+}
    68. 

  68. 						</td> 
    69. 

  69. 					</tr>
    70. 

  70. 				</for>
    71. 

  71. 				</table>
    72. 

  72. 				</if>
    73. 

  73. 				
    74. 

  74. 				<if test="symbol.methods.length">
    75. 

  75. 				<div class="detailHead">methods</div>
    76. 

  76. 				<for each="method" in="symbol.methods">
    77. 

  77. 					<ul class="details">
    78. 

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

  79. 					</ul>
    80. 

  80. 				</for>
    81. 

  81. 				</if>
    82. 

  82. 				
    83. 

  83. 				<if test="symbol.properties.length">
    84. 

  84. 				<div class="detailHead">properties</div>
    85. 

  85. 				<for each="property" in="symbol.properties">
    86. 

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

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

  88. 					</ul>
    89. 

  89. 				</for>
    90. 

  90. 				</if>
    91. 

  91. 				
    92. 

  92. 				<if test="symbol.inherits.length || symbol.augments.length">
    93. 

  93. 					<div class="detailHead">inherits</div>
    94. 

  94. 					<for each="method" in="symbol.getInheritedMethods()">
    95. 

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

  96. 					</for>
    97. 

  97. 				</if>
    98. 

  98. 				
    99. 

  99. 				<if test="symbol.exceptions.length">
    100. 

  100. 				<div class="detailHead">exceptions</div>
    101. 

  101. 				<table class="params">
    102. 

  102. 				<for each="ex" in="symbol.exceptions">
    103. 

  103. 					<tr>
    104. 

  104. 						<td class="type">
    105. 

  105. 							{+ex.type+}
    106. 

  106. 						</td>
    107. 

  107. 						<td>
    108. 

  108. 							{+ex.desc+}
    109. 

  109. 						</td> 
    110. 

  110. 					</tr>
    111. 

  111. 				</for>
    112. 

  112. 				</table>
    113. 

  113. 				</if>
    114. 

  114. 			</div>
    115. 

  115. 			</if>
    116. 

  116. 			</for>
    117. 

  117. 			
    118. 

  118. 			<div class="sectionHead">Functions</div>
    119. 

  119. 			<for each="symbol" in="data.symbols">
    120. 

  120. 			<if test="symbol.is('FUNCTION')">
    121. 

  121. 			<div class="section function">
    122. 

  122. 				<div class="itemTitle">
    123. 

  123. 					<a name="{+symbol.alias+}"></a>
    124. 

  124. 					<if test="symbol.memberof">
    125. 

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

  126. 					</if>
    127. 

  127. 					<if test="!symbol.memberof">
    128. 

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

  129. 					</if>
    130. 

  130. 				</div>
    131. 

  131. 				
    132. 

  132. 				<if test="symbol.desc != 'undocumented'">
    133. 

  133. 					<div class="desc">{+symbol.desc+}</div>
    134. 

  134. 				</if>
    135. 

  135. 				
    136. 

  136. 				<for each="example" in="symbol.doc.getTag('example')">
    137. 

  137. 					<pre class="code">{+example.desc+}</pre>
    138. 

  138. 				</for>
    139. 

  139. 				
    140. 

  140. 				<if test="symbol.params.length">
    141. 

  141. 				<div class="detailHead">parameters</div>
    142. 

  142. 				<table class="params">
    143. 

  143. 				<for each="param" in="symbol.params">
    144. 

  144. 					<tr>
    145. 

  145. 						<td class="type">
    146. 

  146. 							{+param.type+}
    147. 

  147. 						</td>
    148. 

  148. 						<td>
    149. 

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

  150. 						</td>
    151. 

  151. 						<td>
    152. 

  152. 							{+param.desc+}
    153. 

  153. 						</td> 
    154. 

  154. 					</tr>
    155. 

  155. 				</for>
    156. 

  156. 				</table>
    157. 

  157. 				</if>
    158. 

  158. 				
    159. 

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

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

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

  162. 				<for each="ret" in="symbol.returns">
    163. 

  163. 					<tr>
    164. 

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

  165. 							{+ret.type+}
    166. 

  166. 						</td>
    167. 

  167. 						<td>
    168. 

  168. 							{+ret.desc+}
    169. 

  169. 						</td> 
    170. 

  170. 					</tr>
    171. 

  171. 				</for>
    172. 

  172. 				</table>
    173. 

  173. 				</if>
    174. 

  174. 				
    175. 

  175. 				<if test="symbol.exceptions.length">
    176. 

  176. 				<div class="detailHead">exceptions</div>
    177. 

  177. 				<table class="params">
    178. 

  178. 				<for each="ex" in="symbol.exceptions">
    179. 

  179. 					<tr>
    180. 

  180. 						<td class="type">
    181. 

  181. 							{+ex.type+}
    182. 

  182. 						</td>
    183. 

  183. 						<td>
    184. 

  184. 							{+ex.desc+}
    185. 

  185. 						</td> 
    186. 

  186. 					</tr>
    187. 

  187. 				</for>
    188. 

  188. 				</table>
    189. 

  189. 				</if>
    190. 

  190. 			</div>
    191. 

  191. 			</if>
    192. 

  192. 			</for>
    193. 

  193. 			
    194. 

  194. 			<div class="sectionHead">Objects</div>
    195. 

  195. 			<for each="symbol" in="data.symbols">
    196. 

  196. 			<if test="symbol.is('OBJECT')">
    197. 

  197. 			<div class="section object">
    198. 

  198. 				<div class="itemTitle">
    199. 

  199. 					<a name="{+symbol.alias+}"></a>
    200. 

  200. 					<if test="symbol.type">
    201. 

  201. 					<span class="type">{+symbol.type+}</span>
    202. 

  202. 					</if>
    203. 

  203. 					<if test="symbol.memberof">
    204. 

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

  205. 					</if>
    206. 

  206. 					<if test="!symbol.memberof">
    207. 

  207. 						{+symbol.alias+}
    208. 

  208. 					</if>
    209. 

  209. 				</div>
    210. 

  210. 				
    211. 

  211. 				<if test="symbol.desc != 'undocumented'">
    212. 

  212. 					<div class="desc">{+symbol.desc+}</div>
    213. 

  213. 				</if>
    214. 

  214. 				
    215. 

  215. 				<for each="example" in="symbol.doc.getTag('example')">
    216. 

  216. 					<pre class="code">{+example.desc+}</pre>
    217. 

  217. 				</for>
    218. 

  218. 				
    219. 

  219. 				<if test="symbol.properties.length">
    220. 

  220. 				<div class="detailHead">properties</div>
    221. 

  221. 				<table class="params">
    222. 

  222. 				<for each="property" in="symbol.properties">
    223. 

  223. 					<tr>
    224. 

  224. 						<td class="type">
    225. 

  225. 							{+property.type+}
    226. 

  226. 						</td>
    227. 

  227. 						<td>
    228. 

  228. 							{+property.name+}
    229. 

  229. 						</td>
    230. 

  230. 						<td>
    231. 

  231. 							{+property.desc+}
    232. 

  232. 						</td> 
    233. 

  233. 					</tr>
    234. 

  234. 				</for>
    235. 

  235. 				</table>
    236. 

  236. 				</if>
    237. 

  237. 			</div>
    238. 

  238. 			</if>
    239. 

  239. 			
    240. 

  240. 			</for>
    241. 

  241. 		</div>
    242. 

  242. 	</div>
    243. 

  243. 	<div class="finePrint">
    244. 

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

  245. 	</div>
    246. 

  246. </body>
    247. 

  247. </html>
    248.