/branches/version1.x/templates/sweet/file.tmpl
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"http://www.w3.org/TR/html4/loose.dtd"> 3<html> 4<head> 5 <meta http-equiv="content-type" content="text/html; charset={+(JsDoc.opt.e||'utf-8')+}"> 6 <meta name="generator" content="JsDoc Toolkit 1.0"> 7 <title>JsDoc: {+data.overview.name+}</title> 8 <link rel=stylesheet href="default.css" type="text/css" media=screen> 9</head> 10 11<body> 12 <div class="content"> 13 <div class="docs"> 14 15 <div class="sectionHead">Library: {+(data.overview.name||data.filename)+}</div> 16 <div class="section overview"> 17 <div class="itemTitle"> 18 Overview 19 </div> 20 <div> 21 <div class="desc">{+data.overview.desc+}</div> 22 <div class="itemTags"> 23 <ul> 24 <if test="data.source"><li>source: <a href="{+data.source+}">{+data.filename+}</a></li></if> 25 <for each="tag" in="data.overview.doc.tags"> 26 <li>{+tag.title+}: {+tag.desc+}</li> 27 </for> 28 </ul> 29 </div> 30 </div> 31 </div> 32 33 <div class="sectionHead">Constructors</div> 34 <for each="symbol" in="data.symbols"> 35 <if test="symbol.is('CONSTRUCTOR') && !symbol.isStatic"> 36 <div class="section constructor"> 37 <div class="itemTitle"> 38 <a name="{+symbol.alias+}"></a> 39 <if test="symbol.deprecated"><span class="deprecated"><del></if> 40 <if test="symbol.memberof"> 41 <i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}({+symbol.signature()+}) 42 </if> 43 <if test="!symbol.memberof"> 44 {+symbol.alias+}(<span class="signature">{+symbol.signature()+}</span>) 45 </if> 46 <if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if> 47 </div> 48 49 <if test="symbol.desc != 'undocumented'"> 50 <div class="desc">{+symbol.desc+}</div> 51 </if> 52 <if test="(!symbol.desc || symbol.desc == 'undocumented') && symbol.doc.getTag('class').length"> 53 <div class="desc">{+symbol.doc.getTag('class').shift().desc+}</div> 54 </if> 55 56 <if test="symbol.doc.getTag('version').length"> 57 <div>version: {+ symbol.doc.getTag('version').shift(); +}</div> 58 </if> 59 60 <for each="example" in="symbol.doc.getTag('example')"> 61 <pre class="code">{+example.desc+}</pre> 62 </for> 63 64 <if test="symbol.params.length"> 65 <div class="detailHead">parameters</div> 66 <table class="params"> 67 <for each="param" in="symbol.params"> 68 <tr> 69 <td class="type"> 70 {+linkToType(param.type)+} 71 </td> 72 <td> 73 {+param.name+}<if test="param.isOptional"><a title="optional parameter" class="optional">?</a></if> 74 <if test="param.defaultValue != ''"><span class="optional">= {+param.defaultValue+}</span></if> 75 </td> 76 <td> 77 {+param.desc+} 78 </td> 79 </tr> 80 </for> 81 </table> 82 </if> 83 84 <if test="symbol.methods.length"> 85 <div class="detailHead">methods</div> 86 <for each="method" in="symbol.methods"> 87 <ul class="details"> 88 <li><a href="#{+method.alias+}">{+method.name+}</a>({+method.signature()+})</li> 89 </ul> 90 </for> 91 </if> 92 93 <if test="symbol.properties.length"> 94 <div class="detailHead">properties</div> 95 <for each="property" in="symbol.properties"> 96 <ul class="details"> 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 </ul> 99 </for> 100 </if> 101 102 <if test="symbol.inherits.length || symbol.augments.length"> 103 <div class="detailHead">inherits</div> 104 <for each="method" in="symbol.getInheritedMethods()"> 105 <div>{+method.name+}(<span class="signature">{+method.signature()+}</span>) from {+method.memberof+}</div> 106 </for> 107 </if> 108 109 <if test="symbol.exceptions.length"> 110 <div class="detailHead">exceptions</div> 111 <table class="params"> 112 <for each="ex" in="symbol.exceptions"> 113 <tr> 114 <td class="type"> 115 {+linkToType(ex.type)+} 116 </td> 117 <td> 118 {+ex.desc+} 119 </td> 120 </tr> 121 </for> 122 </table> 123 </if> 124 </div> 125 </if> 126 </for> 127 128 <div class="sectionHead">Namespaces</div> 129 <for each="symbol" in="data.symbols"> 130 <if test="symbol.is('CONSTRUCTOR') && symbol.isStatic"> 131 <div class="section object"> 132 <div class="itemTitle"> 133 <a name="{+symbol.alias+}"></a> 134 <if test="symbol.deprecated"><span class="deprecated"><del></if> 135 <if test="symbol.memberof"> 136 <i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}({+symbol.signature()+}) 137 </if> 138 <if test="!symbol.memberof"> 139 {+symbol.alias+} 140 </if> 141 <if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if> 142 </div> 143 144 <if test="symbol.desc != 'undocumented'"> 145 <div class="desc">{+symbol.desc+}</div> 146 </if> 147 <if test="(!symbol.desc || symbol.desc == 'undocumented') && symbol.doc.getTag('class').length"> 148 <div class="desc">{+symbol.doc.getTag('class').shift().desc+}</div> 149 </if> 150 151 <if test="symbol.doc.getTag('version').length"> 152 <div>version: {+ symbol.doc.getTag('version').shift(); +}</div> 153 </if> 154 155 <for each="example" in="symbol.doc.getTag('example')"> 156 <pre class="code">{+example.desc+}</pre> 157 </for> 158 159 <if test="symbol.params.length"> 160 <div class="detailHead">parameters</div> 161 <table class="params"> 162 <for each="param" in="symbol.params"> 163 <tr> 164 <td class="type"> 165 {+linkToType(param.type)+} 166 </td> 167 <td> 168 {+param.name+}<if test="param.isOptional"><a title="optional parameter" class="optional">?</a></if> 169 <if test="param.defaultValue != ''"><span class="optional">= {+param.defaultValue+}</span></if> 170 </td> 171 <td> 172 {+param.desc+} 173 </td> 174 </tr> 175 </for> 176 </table> 177 </if> 178 179 <if test="symbol.methods.length"> 180 <div class="detailHead">methods</div> 181 <for each="method" in="symbol.methods"> 182 <ul class="details"> 183 <li><a href="#{+method.alias+}">{+method.name+}</a>({+method.signature()+})</li> 184 </ul> 185 </for> 186 </if> 187 188 <if test="symbol.properties.length"> 189 <div class="detailHead">properties</div> 190 <for each="property" in="symbol.properties"> 191 <ul class="details"> 192 <li><if test="property.type"><span class="type">{+property.type+}</span> </if><a href="#{+property.alias+}">{+property.name+}</a></li> 193 </ul> 194 </for> 195 </if> 196 197 <if test="symbol.inherits.length || symbol.augments.length"> 198 <div class="detailHead">inherits</div> 199 <for each="method" in="symbol.getInheritedMethods()"> 200 <div>{+method.name+}(<span class="signature">{+method.signature()+}</span>) from {+method.memberof+}</div> 201 </for> 202 </if> 203 204 <if test="symbol.exceptions.length"> 205 <div class="detailHead">exceptions</div> 206 <table class="params"> 207 <for each="ex" in="symbol.exceptions"> 208 <tr> 209 <td class="type"> 210 {+linkToType(ex.type)+} 211 </td> 212 <td> 213 {+ex.desc+} 214 </td> 215 </tr> 216 </for> 217 </table> 218 </if> 219 </div> 220 </if> 221 </for> 222 223 <div class="sectionHead">Functions</div> 224 <for each="symbol" in="data.symbols"> 225 <if test="symbol.is('FUNCTION')"> 226 <div class="section function"> 227 <div class="itemTitle"> 228 <a name="{+symbol.alias+}"></a> 229 <if test="symbol.deprecated"><span class="deprecated"><del></if> 230 <if test="symbol.memberof"> 231 <i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+}(<span class="signature">{+symbol.signature()+}</span>) 232 </if> 233 <if test="!symbol.memberof"> 234 {+symbol.alias+}(<span class="signature">{+symbol.signature()+}</span>) 235 </if> 236 <if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if> 237 </div> 238 239 <if test="symbol.desc != 'undocumented'"> 240 <div class="desc">{+symbol.desc+}</div> 241 </if> 242 243 <if test="symbol.doc.getTag('since').length"> 244 <div>since: {+ symbol.doc.getTag('since').shift(); +}</div> 245 </if> 246 247 <for each="example" in="symbol.doc.getTag('example')"> 248 <pre class="code">{+example.desc+}</pre> 249 </for> 250 251 <if test="symbol.params.length"> 252 <div class="detailHead">parameters</div> 253 <table class="params"> 254 <for each="param" in="symbol.params"> 255 <tr> 256 <td class="type"> 257 {+linkToType(param.type)+} 258 </td> 259 <td> 260 {+param.name+}<if test="param.isOptional"><a title="optional parameter" class="optional">?</a></if> 261 <if test="param.defaultValue != ''"><span class="optional">= {+param.defaultValue+}</span></if> 262 </td> 263 <td> 264 {+param.desc+} 265 </td> 266 </tr> 267 </for> 268 </table> 269 </if> 270 271 <if test="symbol.returns.length"> 272 <div class="detailHead">returns</div> 273 <table class="params"> 274 <for each="ret" in="symbol.returns"> 275 <tr> 276 <td class="type"> 277 {+linkToType(ret.type)+} 278 </td> 279 <td> 280 {+ret.desc+} 281 </td> 282 </tr> 283 </for> 284 </table> 285 </if> 286 287 <if test="symbol.exceptions.length"> 288 <div class="detailHead">exceptions</div> 289 <table class="params"> 290 <for each="ex" in="symbol.exceptions"> 291 <tr> 292 <td class="type"> 293 {+linkToType(ex.type)+} 294 </td> 295 <td> 296 {+ex.desc+} 297 </td> 298 </tr> 299 </for> 300 </table> 301 </if> 302 </div> 303 </if> 304 </for> 305 306 <div class="sectionHead">Objects</div> 307 <for each="symbol" in="data.symbols"> 308 <if test="symbol.is('OBJECT')"> 309 <div class="section object"> 310 <div class="itemTitle"> 311 <a name="{+symbol.alias+}"></a> 312 <if test="symbol.type"> 313 <span class="type">{+symbol.type+}</span> 314 </if> 315 <if test="symbol.deprecated"><span class="deprecated"><del></if> 316 <if test="symbol.memberof"> 317 <i><a href="#{+symbol.memberof+}" class="type">{+symbol.memberof+}.</a></i>{+symbol.name+} 318 </if> 319 <if test="!symbol.memberof"> 320 {+symbol.alias+} 321 </if> 322 <if test="symbol.deprecated"></del> deprecated {+symbol.deprecated.desc+}</span></if> 323 </div> 324 325 <if test="symbol.desc != 'undocumented'"> 326 <div class="desc">{+symbol.desc+}</div> 327 </if> 328 329 <if test="symbol.doc.getTag('since').length"> 330 <div>since: {+ symbol.doc.getTag('since').shift(); +}</div> 331 </if> 332 333 <for each="example" in="symbol.doc.getTag('example')"> 334 <pre class="code">{+example.desc+}</pre> 335 </for> 336 337 <if test="symbol.properties.length"> 338 <div class="detailHead">properties</div> 339 <table class="params"> 340 <for each="property" in="symbol.properties"> 341 <tr> 342 <td class="type"> 343 {+linkToType(property.type)+} 344 </td> 345 <td> 346 {+property.name+} 347 </td> 348 <td> 349 {+property.desc+} 350 </td> 351 </tr> 352 </for> 353 </table> 354 </if> 355 </div> 356 </if> 357 </for> 358 </div> 359 </div> 360 <div class="finePrint"> 361 Generated by <a href="http://jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> {+JsDoc.VERSION+} on {+new Date().toUTCString()+}. 362 </div> 363</body> 364</html>