/tags/jsdoc_toolkit-1.3.3/templates/sunny/class.tmpl
Go Template | 384 lines | 352 code | 32 blank | 0 comment | 0 complexity | 0596247f35470589cc053bfe255a7aa9 MD5 | raw file
1{! 2function byName(a, b) { 3 if (a.name != undefined && b.name != undefined) { 4 a = a.name.toLowerCase(); 5 b = b.name.toLowerCase(); 6 if (a < b) return -1; 7 if (a > b) return 1; 8 return 0; 9 } 10} 11 12function summarize(desc) { 13 if (typeof desc != "undefined") 14 return desc.match(/([\w\W]+?\.)[^a-z0-9]/i)? RegExp.$1 : desc; 15} 16 17thisClass = data[0]; 18!} 19<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 20 "http://www.w3.org/TR/html4/loose.dtd"> 21<html> 22<head> 23 <meta http-equiv="content-type" content="text/html; charset=utf-8"> 24 <title>JsDoc: {+thisClass.alias+}</title> 25 <style type="text/css"> 26 body { background-color: #FFFFFF; } 27 .TableHeadingColor { background: #CCCCFF; } 28 .TableSubHeadingColor { background: #EEEEFF; } 29 .TableRowColor { background: #FFFFFF; } 30 31 .FrameTitleFont 32 { 33 font-size: 10pts; 34 font-family: Helvetica, Arial, san-serif; 35 } 36 37 .FrameHeadingFont 38 { 39 font-size: 10pts; 40 font-family: Helvetica, Arial, san-serif; 41 } 42 43 .FrameItemFont 44 { 45 font-size: 10pts; 46 font-family: Helvetica, Arial, san-serif; 47 } 48 49 .NavBar 50 { 51 font-family: Arial, Helvetica, sans-serif; 52 background-color: #FFFFFF; 53 } 54 55 .jsdoc_ctime 56 { 57 font-family: Arial, Helvetica, sans-serif; 58 font-size: 9pt; 59 text-align: right; 60 } 61 </style> 62</head> 63 64<body> 65 66<table style="width: 100%"> 67<tr> 68<td class="NavBar" valign="top"><font size="-2">SUMMARY: <a href="#field_summary">FIELD</a> | <a href="#constructor_summary">CONSTR</a> | <a href="#method_summary">METHOD</a></font></td> 69<td class="NavBar" valign="top"><font size="-2">DETAIL: <a href="#field_detail">FIELD</a> | <a href="#constructor_detail">CONSTR</a> | <a href="#method_detail">METHOD</a></font></td> 70</tr> 71</table> 72 73<hr> 74 75<h2><if test="thisClass.isStatic">Static </if>Class {+thisClass.alias+}</h2> 76 77<if test="thisClass.augments && thisClass.augments.length"> 78 Extends<for each="augment" in="thisClass.augments"> <a href="{+augment+}.html">{+augment+}</a></for>.<br/> 79</if> 80<if test="thisClass.source"><i>Defined in <a href="{+thisClass.source+}">{+thisClass.filename+}</a></i></if> 81<if test="thisClass.classDesc"><p>{+thisClass.classDesc+}</p></if> 82<if test="thisClass.doc"> 83<for each="author" in="thisClass.doc.getTag('author')"> 84<b>Author:</b> {+author+}<br/> 85</for> 86<for each="version" in="thisClass.doc.getTag('version')"> 87<b>Version:</b> {+version+}<br/> 88</for> 89</if> 90<hr> 91 92<!-- =========== FIELD SUMMARY =========== --> 93<if test="thisClass.properties.length"> 94<a name="field_summary"> </a> 95<table border="1" cellpadding="3" cellspacing="0" width="100%"> 96 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 97 <td colspan=2> 98 <font size="+2"> <b>Field Summary</b></font> 99 </td> 100 </tr> 101 <for each="property" in="thisClass.properties.sort(byName)"> 102 <tr bgcolor="white" class="TableRowColor"> 103 <td align="right" valign="top" width="1%"> 104 <font size="-1"><code><if test="property.isPrivate"><private> </if><if test="property.isStatic||!property.memberof"><static> </if>{+(property.type||"object")+}</code></font> 105 </td> 106 <td> 107 <code><b><a href="#{+property.name+}">{+property.name+}</a></b></code> 108 <br> 109 {+summarize(property.desc)+} 110 </td> 111 </tr> 112 </for> 113</table> 114 115</if> 116<!-- =========== END FIELD SUMMARY =========== --> 117 118<if test="!thisClass.isStatic"> 119<!-- ======== CONSTRUCTOR SUMMARY ======== --> 120<a name="constructor_summary"> </a> 121<table border="1" cellpadding="3" cellspacing="0" width="100%"> 122<tr bgcolor="#CCCCFF" class="TableHeadingColor"> 123 <td colspan=2><font size="+2"><b>Constructor Summary</b></font></td> 124</tr> 125<for each="cn" in="data"> 126 <tr bgcolor="white" class="TableRowColor"> 127 <td> 128 129 <code> 130 <b><a href="#{+cn.name+}">{+cn.alias+}</a></b>({+cn.signature()+}) 131 </code> 132 <br> 133 134 {+summarize(cn.desc)+} 135 </td> 136 </tr> 137</for> 138</table> 139 140<!-- ======== END CONSTRUCTOR SUMMARY ======== --> 141</if> 142 143<!-- ========== METHOD SUMMARY =========== --> 144<if test="thisClass.methods.length"> 145<a name="method_summary"> </a> 146<table border="1" cellpadding="3" cellspacing="0" width="100%"> 147 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 148 <td colspan=2> 149 <font size="+2"> <b>Method Summary</b></font> 150 </td> 151 </tr> 152 <for each="method" in="thisClass.methods.sort(byName)"> 153 <tr bgcolor="white" class="TableRowColor"> 154 <td align="right" valign="top" width="1%"> 155 <font size="-1"><code><if test="method.isPrivate"><private> </if><if test="method.isStatic||!method.memberof"><static> </if><if test="method.returns.length"> 156 <for each="ret" in="method.returns"> {+ret.type+}</for> 157 </if></code></font> 158 </td> 159 <td> 160 <code> <b> <a href="#{+method.name+}">{+method.name+}</a></b>({+method.signature()+}) </code> 161 <br> 162 {+summarize(method.desc)+} 163 164 </td> 165 </tr> 166 </for> 167</table> 168 169</if> 170<!-- ========== EVENT SUMMARY =========== --> 171<if test="thisClass.events"> 172<if test="thisClass.events.length"> 173<a name="event_summary"> </a> 174<table border="1" cellpadding="3" cellspacing="0" width="100%"> 175 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 176 <td colspan=2> 177 <font size="+2"> <b>Event Summary</b></font> 178 </td> 179 </tr> 180 <for each="event" in="thisClass.events.sort(byName)"> 181 <tr bgcolor="white" class="TableRowColor"> 182 <td align="right" valign="top" width="1%"> 183 <font size="-1"><code><if test="event.isPrivate"><private> </if> 184 185 <if test="event.returns.length"> 186 <for each="ret" in="event.returns"> {+ret.type+}</for> 187 </if> 188 <if test="event.returns.length==0"> 189 void 190 </if></code></font> 191 </td> 192 <td> 193 <code> <b> <a href="#{+event.name+}">{+event.name+}</a></b>({+event.signature()+}) </code> 194 <br> 195 {+summarize(event.desc)+} 196 197 </td> 198 </tr> 199 </for> 200</table> 201 202</if> 203</if> 204<!-- ========== INHERITED METHODS SUMMARY =========== --> 205<if test="thisClass.inherited"> 206 <table border="1" cellpadding="3" cellspacing="0" width="100%"> 207 <for each="className" in="keys(thisClass.inherited)"> 208 <tr bgcolor="#EEEEFF" class="TableSubHeadingColor"> 209 <td> 210 <b>Methods inherited from class <a href="{+className+}.html">{+className+}</a></b> 211 </td> 212 </tr> 213 <for each="method" in="thisClass.inherited[className]"> 214 <tr bgcolor="#EEEEFF" class="TableSubHeadingColor"> 215 <td> 216 <a href="{+method.memberof+}.html#{+method.name+}">{+method.name+}</a>({+method.signature()+}) 217 </td> 218 </tr> 219 </for> 220 </for> 221 </table> 222 <br/> 223</if> 224<br/> 225 226<!-- ========== END INHERITED METHODS SUMMARY =========== --> 227 228<!-- ============ FIELD DETAIL START ========= --> 229<if test="thisClass.properties.length"> 230<a name="field_detail"> </a> 231<table border="1" cellpadding="3" cellspacing="0" width="100%"> 232 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 233 <td colspan=1> 234 <font size="+2"> <b>Field Detail</b></font> 235 </td> 236 </tr> 237</table> 238 239<for each="property" in="thisClass.properties.sort(byName)"> 240 <!-- One single method detail entry --> 241 <a name="{+property.name+}"> 242 <!-- --> 243 </a> <h3>{+property.name+}</h3> 244 <pre><if test="property.isPrivate"><private> </if><if test="property.isStatic||!property.memberof"><static> </if>{+(property.type||"object")+} <b>{+property.name+}</b></pre> 245 <ul> 246 {+property.desc+} 247 </ul> 248 <hr> 249</for> 250</if> 251<!-- ============ FIELD DETAIL END ========== --> 252 253<if test="!thisClass.isStatic"> 254<!-- ========= CONSTRUCTOR DETAIL START ======== --> 255<a name="constructor_detail"> </a> 256<table border="1" cellpadding="3" cellspacing="0" width="100%"> 257 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 258 <td colspan=1> 259 <font size="+2"><b>Constructor Detail</b></font> 260 </td> 261 </tr> 262 263</table> 264 265<a name="{+thisClass.name+}"> </a> 266<h3>{+thisClass.alias+}</h3> 267<for each="cn" in="data"> 268 <pre><b>{+cn.alias+}</b>({+cn.signature()+})</pre> 269 <ul> 270 {+cn.desc+} 271 </ul> 272 273 <!-- PARAMETERS START --> 274 <if test="cn.params.length"> 275 <ul> 276 <b>Parameters:</b> 277 <for each="param" in="cn.params"> 278 <ul> 279 <code><if test="param.type"><i>{+param.type+}</i> </if>{+param.name+}</code><if test="param.desc"> - {+param.desc+}</if> 280 </ul> 281 </for> 282 </ul> 283 </if> 284 <!-- PARAMETERS END --> 285</for> 286<hr/> 287<!-- END ADDITIONAL ATTRIBUTES --> 288<!-- ========= CONSTRUCTOR DETAIL END ======== --> 289</if> 290 291<!-- ============ METHOD DETAIL START ======= --> 292<if test="thisClass.methods.length"> 293<a name="method_detail"> </a> 294<table border="1" cellpadding="3" cellspacing="0" width="100%"> 295 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 296 <td colspan=1> 297 <font size="+2"> <b>Method Detail</b></font> 298 </td> 299 </tr> 300</table> 301 302<for each="method" in="thisClass.methods.sort(byName)"> 303 <a name="{+method.name+}"> </a> <h3>{+method.name+}</h3> 304 <pre><if test="method.isPrivate"><private> </if><if test="method.isStatic||!method.memberof"><static> </if><if test="method.returns.length"><for each="ret" in="method.returns">{+ret.type+} </for></if><b>{+method.name+}</b>({+method.signature()+})</pre> 305 <ul> 306 {+method.desc+} 307 </ul> 308 <!-- METHOD PARAMETERS START --> 309 <if test="method.params.length"><ul> 310 <b>Parameters:</b><for each="param" in="method.params"> 311 <ul> 312 <code><if test="param.type"><i>{+param.type+}</i> </if>{+param.name+} </code><if test="param.desc"> - {+param.desc+}</if> 313 </ul></for> 314 </ul></if> 315 <!-- METHOD PARAMETERS END --> 316 <!-- ADDITIONAL ATTRIBUTES START --> 317 <if test="method.returns.length"><ul> 318 <b>Returns:</b><for each="ret" in="method.returns"> 319 <ul> 320 <code><if test="ret.type"><i>{+ret.type+}</i> </if></code>{+ret.desc+} 321 </ul></for> 322 </ul></if> 323 <if test="method.exceptions.length"><ul> 324 <b>Throws:</b><for each="ex" in="method.exceptions"> 325 <ul> 326 <code>{+ex.type+}</code> {+ex.desc+} 327 </ul></for> 328 </ul></if> 329 <!-- ADDITIONAL ATTRIBUTES END --> 330 <hr> 331</for> 332</if> 333<!-- ============ METHOD DETAIL END ========== --> 334 335 336 337<!-- ============ EVENT DETAIL START ======= --> 338<if test="thisClass.events"> 339<if test="thisClass.events.length"> 340<a name="method_detail"> </a> 341<table border="1" cellpadding="3" cellspacing="0" width="100%"> 342 <tr bgcolor="#CCCCFF" class="TableHeadingColor"> 343 <td colspan=1> 344 <font size="+2"> <b>Event Detail</b></font> 345 </td> 346 </tr> 347</table> 348 349<for each="event" in="thisClass.events.sort(byName)"> 350 <a name="{+event.name+}"> </a> <h3>{+event.name+}</h3> 351 <pre><if test="event.isPrivate"><private> </if><if test="event.isStatic||!event.memberof"><static> </if><if test="event.returns.length"><for each="ret" in="event.returns">{+ret.type+} </for></if><b>{+event.name+}</b>({+event.signature()+})</pre> 352 <ul> 353 {+event.desc+} 354 </ul> 355 <!-- EVENT PARAMETERS START --> 356 <if test="event.params.length"><ul> 357 <b>Parameters:</b><for each="param" in="event.params"> 358 <ul> 359 <code><if test="param.type"><i>{+param.type+}</i> </if>{+param.name+} </code><if test="param.desc"> - {+param.desc+}</if> 360 </ul></for> 361 </ul></if> 362 <!-- EVENT PARAMETERS END --> 363 <!-- ADDITIONAL ATTRIBUTES START --> 364 <if test="event.returns.length"><ul> 365 <b>Returns:</b><for each="ret" in="event.returns"> 366 <ul> 367 <code><if test="ret.type"><i>{+ret.type+}</i> </if></code>{+ret.desc+} 368 </ul></for> 369 </ul></if> 370 <if test="event.exceptions.length"><ul> 371 <b>Throws:</b><for each="ex" in="event.exceptions"> 372 <ul> 373 <code>{+ex.type+}</code> {+ex.desc+} 374 </ul></for> 375 </ul></if> 376 <!-- ADDITIONAL ATTRIBUTES END --> 377 <hr> 378</for> 379</if> 380</if> 381<!-- ============ EVENT DETAIL END ========== --> 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</body> 384</html>