PageRenderTime 90ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/tags/jsdoc_toolkit-2.0.1/jsdoc-toolkit/templates/jsdoc/class.tmpl

http://jsdoc-toolkit.googlecode.com/
Go Template | 487 lines | 450 code | 37 blank | 0 comment | 0 complexity | 833e1f1afb71970e5e40aa39460d8074 MD5 | raw file
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
  6. <meta name="generator" content="JsDoc Toolkit" />
  7. {! Link.base = "../"; /* all generated links will be relative to this */ !}
  8. <title>JsDoc Reference - {+data.alias+}</title>
  9. <style type="text/css">
  10. {+include("static/default.css")+}
  11. </style>
  12. </head>
  13. <body>
  14. <!-- ============================== header ================================= -->
  15. <!-- begin static/header.html -->
  16. {+include("static/header.html")+}
  17. <!-- end static/header.html -->
  18. <!-- ============================== classes index ============================ -->
  19. <div id="index">
  20. <!-- begin publish.classesIndex -->
  21. {+publish.classesIndex+}
  22. <!-- end publish.classesIndex -->
  23. </div>
  24. <div id="content">
  25. <!-- ============================== class title ============================ -->
  26. <h1 class="classTitle">
  27. {!
  28. var classType = "";
  29. if (data.isBuiltin()) {
  30. classType += "Built-In ";
  31. }
  32. if (data.isNamespace) {
  33. if (data.is('FUNCTION')) {
  34. classType += "Function ";
  35. }
  36. classType += "Namespace ";
  37. }
  38. else {
  39. classType += "Class ";
  40. }
  41. !}
  42. {+classType+}{+data.alias+}
  43. </h1>
  44. <!-- ============================== class summary ========================== -->
  45. <p class="description">
  46. <if test="data.augments.length"><br />Extends
  47. {+
  48. data.augments
  49. .sort()
  50. .map(
  51. function($) { return new Link().toSymbol($); }
  52. )
  53. .join(", ")
  54. +}.<br />
  55. </if>
  56. {+resolveLinks(data.classDesc)+}
  57. <if test="!data.isBuiltin()">{# isn't defined in any file #}
  58. <br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}.
  59. </if>
  60. </p>
  61. <!-- ============================== constructor summary ==================== -->
  62. <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
  63. <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class {+data.alias+}.">
  64. <caption>{+classType+}Summary</caption>
  65. <thead>
  66. <tr>
  67. <th scope="col">Constructor Attributes</th>
  68. <th scope="col">Constructor Name and Description</th>
  69. </tr>
  70. </thead>
  71. <tbody>
  72. <tr>
  73. <td class="attributes">{!
  74. if (data.isPrivate) output += "&lt;private&gt; ";
  75. if (data.isInner) output += "&lt;inner&gt; ";
  76. !}&nbsp;</td>
  77. <td class="nameDescription" {!if (data.comment.getTag("hilited").length){output += 'style="color: red"'}!}>
  78. <div class="fixedFont">
  79. <b>{+ new Link().toSymbol(data.alias).inner('constructor')+}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
  80. </div>
  81. <div class="description">{+resolveLinks(summarize(data.desc))+}</div>
  82. </td>
  83. </tr>
  84. </tbody>
  85. </table>
  86. </if>
  87. <!-- ============================== properties summary ===================== -->
  88. <if test="data.properties.length">
  89. {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
  90. <if test="ownProperties.length">
  91. <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}.">
  92. <caption>Field Summary</caption>
  93. <thead>
  94. <tr>
  95. <th scope="col">Field Attributes</th>
  96. <th scope="col">Field Name and Description</th>
  97. </tr>
  98. </thead>
  99. <tbody>
  100. <for each="member" in="ownProperties">
  101. <tr>
  102. <td class="attributes">{!
  103. if (member.isPrivate) output += "&lt;private&gt; ";
  104. if (member.isInner) output += "&lt;inner&gt; ";
  105. if (member.isStatic) output += "&lt;static&gt; ";
  106. if (member.isConstant) output += "&lt;constant&gt; ";
  107. !}&nbsp;</td>
  108. <td class="nameDescription">
  109. <div class="fixedFont">
  110. <if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>
  111. </div>
  112. <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
  113. </td>
  114. </tr>
  115. </for>
  116. </tbody>
  117. </table>
  118. </if>
  119. <if test="data.inheritsFrom.length">
  120. <dl class="inheritsList">
  121. {!
  122. var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
  123. var contributers = [];
  124. borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
  125. for (var i = 0, l = contributers.length; i < l; i++) {
  126. output +=
  127. "<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
  128. +
  129. "<dd>" +
  130. borrowedMembers
  131. .filter(
  132. function($) { return $.memberOf == contributers[i] }
  133. )
  134. .sort(makeSortby("name"))
  135. .map(
  136. function($) { return new Link().toSymbol($.alias).withText($.name) }
  137. )
  138. .join(", ")
  139. +
  140. "</dd>";
  141. }
  142. !}
  143. </dl>
  144. </if>
  145. </if>
  146. <!-- ============================== methods summary ======================== -->
  147. <if test="data.methods.length">
  148. {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
  149. <if test="ownMethods.length">
  150. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}.">
  151. <caption>Method Summary</caption>
  152. <thead>
  153. <tr>
  154. <th scope="col">Method Attributes</th>
  155. <th scope="col">Method Name and Description</th>
  156. </tr>
  157. </thead>
  158. <tbody>
  159. <for each="member" in="ownMethods">
  160. <tr>
  161. <td class="attributes">{!
  162. if (member.isPrivate) output += "&lt;private&gt; ";
  163. if (member.isInner) output += "&lt;inner&gt; ";
  164. if (member.isStatic) output += "&lt;static&gt; ";
  165. !}&nbsp;</td>
  166. <td class="nameDescription">
  167. <div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>{+makeSignature(member.params)+}
  168. </div>
  169. <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
  170. </td>
  171. </tr>
  172. </for>
  173. </tbody>
  174. </table>
  175. </if>
  176. <if test="data.inheritsFrom.length">
  177. <dl class="inheritsList">
  178. {!
  179. var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
  180. var contributers = [];
  181. borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
  182. for (var i = 0, l = contributers.length; i < l; i++) {
  183. output +=
  184. "<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
  185. +
  186. "<dd>" +
  187. borrowedMembers
  188. .filter(
  189. function($) { return $.memberOf == contributers[i] }
  190. )
  191. .sort(makeSortby("name"))
  192. .map(
  193. function($) { return new Link().toSymbol($.alias).withText($.name) }
  194. )
  195. .join(", ")
  196. +
  197. "</dd>";
  198. }
  199. !}
  200. </dl>
  201. </if>
  202. </if>
  203. <!-- ============================== constructor details ==================== -->
  204. <if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
  205. <div class="details"><a name="constructor"> </a>
  206. <div class="sectionTitle">
  207. {+classType+}Detail
  208. </div>
  209. <div class="fixedFont">{!
  210. if (data.isPrivate) output += "&lt;private&gt; ";
  211. if (data.isInner) output += "&lt;inner&gt; ";
  212. !}
  213. <b>{+ data.alias +}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
  214. </div>
  215. <div class="description">
  216. {+resolveLinks(data.desc)+}
  217. <if test="data.author"><br /><i>Author: </i>{+data.author+}.</if>
  218. </div>
  219. <if test="data.example.length">
  220. <for each="example" in="data.example">
  221. <pre class="code">{+example+}</pre>
  222. </for>
  223. </if>
  224. <if test="data.params.length">
  225. <dl class="detailList">
  226. <dt class="heading">Parameters:</dt>
  227. <for each="item" in="data.params">
  228. <dt>
  229. {+((item.type)?""+("<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type)+"}</span> ")) : "")+} <b>{+item.name+}</b>
  230. <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
  231. </dt>
  232. <dd>{+resolveLinks(item.desc)+}</dd>
  233. </for>
  234. </dl>
  235. </if>
  236. <if test="data.deprecated">
  237. <dl class="detailList">
  238. <dt class="heading">Deprecated:</dt>
  239. <dt>
  240. {+resolveLinks(data.deprecated)+}
  241. </dt>
  242. </dl>
  243. </if>
  244. <if test="data.since">
  245. <dl class="detailList">
  246. <dt class="heading">Since:</dt>
  247. <dd>{+ data.since +}</dd>
  248. </dl>
  249. </if>
  250. <if test="data.exceptions.length">
  251. <dl class="detailList">
  252. <dt class="heading">Throws:</dt>
  253. <for each="item" in="data.exceptions">
  254. <dt>
  255. {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
  256. </dt>
  257. <dd>{+resolveLinks(item.desc)+}</dd>
  258. </for>
  259. </dl>
  260. </if>
  261. <if test="data.returns.length">
  262. <dl class="detailList">
  263. <dt class="heading">Returns:</dt>
  264. <for each="item" in="data.returns">
  265. <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
  266. </for>
  267. </dl>
  268. </if>
  269. <if test="data.requires.length">
  270. <dl class="detailList">
  271. <dt class="heading">Requires:</dt>
  272. <for each="item" in="data.requires">
  273. <dd>{+ resolveLinks(item) +}</dd>
  274. </for>
  275. </dl>
  276. </if>
  277. <if test="data.see.length">
  278. <dl class="detailList">
  279. <dt class="heading">See:</dt>
  280. <for each="item" in="data.see">
  281. <dd>{+ new Link().toSymbol(item) +}</dd>
  282. </for>
  283. </dl>
  284. </if>
  285. </div>
  286. </if>
  287. <!-- ============================== field details ========================== -->
  288. <if test="defined(ownProperties) && ownProperties.length">
  289. <div class="sectionTitle">
  290. Field Detail
  291. </div>
  292. <for each="member" in="ownProperties">
  293. <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
  294. <div class="fixedFont">{!
  295. if (member.isPrivate) output += "&lt;private&gt; ";
  296. if (member.isInner) output += "&lt;inner&gt; ";
  297. if (member.isStatic) output += "&lt;static&gt; ";
  298. if (member.isConstant) output += "&lt;constant&gt; ";
  299. !}
  300. <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
  301. <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>
  302. </div>
  303. <div class="description">
  304. {+resolveLinks(member.desc)+}
  305. <if test="member.srcFile != data.srcFile">
  306. <br />
  307. <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
  308. </if>
  309. <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
  310. </div>
  311. <if test="member.example.length">
  312. <for each="example" in="member.example">
  313. <pre class="code">{+example+}</pre>
  314. </for>
  315. </if>
  316. <if test="member.deprecated">
  317. <dl class="detailList">
  318. <dt class="heading">Deprecated:</dt>
  319. <dt>
  320. {+ member.deprecated +}
  321. </dt>
  322. </dl>
  323. </if>
  324. <if test="member.since">
  325. <dl class="detailList">
  326. <dt class="heading">Since:</dt>
  327. <dd>{+ member.since +}</dd>
  328. </dl>
  329. </if>
  330. <if test="member.see.length">
  331. <dl class="detailList">
  332. <dt class="heading">See:</dt>
  333. <for each="item" in="member.see">
  334. <dd>{+ new Link().toSymbol(item) +}</dd>
  335. </for>
  336. </dl>
  337. </if>
  338. <if test="member.defaultValue">
  339. <dl class="detailList">
  340. <dt class="heading">Default Value:</dt>
  341. <dd>
  342. {+resolveLinks(member.defaultValue)+}
  343. </dd>
  344. </dl>
  345. </if>
  346. <if test="!$member_last"><hr /></if>
  347. </for>
  348. </if>
  349. <!-- ============================== method details ========================= -->
  350. <if test="defined(ownMethods) && ownMethods.length">
  351. <div class="sectionTitle">
  352. Method Detail
  353. </div>
  354. <for each="member" in="ownMethods">
  355. <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
  356. <div class="fixedFont">{!
  357. if (member.isPrivate) output += "&lt;private&gt; ";
  358. if (member.isInner) output += "&lt;inner&gt; ";
  359. if (member.isStatic) output += "&lt;static&gt; ";
  360. !}
  361. <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
  362. <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
  363. </div>
  364. <div class="description">
  365. {+resolveLinks(member.desc)+}
  366. <if test="member.srcFile != data.srcFile">
  367. <br />
  368. <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
  369. </if>
  370. <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
  371. </div>
  372. <if test="member.example.length">
  373. <for each="example" in="member.example">
  374. <pre class="code">{+example+}</pre>
  375. </for>
  376. </if>
  377. <if test="member.params.length">
  378. <dl class="detailList">
  379. <dt class="heading">Parameters:</dt>
  380. <for each="item" in="member.params">
  381. <dt>
  382. {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
  383. <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
  384. </dt>
  385. <dd>{+resolveLinks(item.desc)+}</dd>
  386. </for>
  387. </dl>
  388. </if>
  389. <if test="member.deprecated">
  390. <dl class="detailList">
  391. <dt class="heading">Deprecated:</dt>
  392. <dt>
  393. {+member.deprecated+}
  394. </dt>
  395. </dl>
  396. </if>
  397. <if test="member.since">
  398. <dl class="detailList">
  399. <dt class="heading">Since:</dt>
  400. <dd>{+ member.since +}</dd>
  401. </dl>
  402. </dl>
  403. </if>
  404. <if test="member.exceptions.length">
  405. <dl class="detailList">
  406. <dt class="heading">Throws:</dt>
  407. <for each="item" in="member.exceptions">
  408. <dt>
  409. {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
  410. </dt>
  411. <dd>{+resolveLinks(item.desc)+}</dd>
  412. </for>
  413. </dl>
  414. </if>
  415. <if test="member.returns.length">
  416. <dl class="detailList">
  417. <dt class="heading">Returns:</dt>
  418. <for each="item" in="member.returns">
  419. <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
  420. </for>
  421. </dl>
  422. </if>
  423. <if test="member.requires.length">
  424. <dl class="detailList">
  425. <dt class="heading">Requires:</dt>
  426. <for each="item" in="member.requires">
  427. <dd>{+ resolveLinks(item) +}</dd>
  428. </for>
  429. </dl>
  430. </if>
  431. <if test="member.see.length">
  432. <dl class="detailList">
  433. <dt class="heading">See:</dt>
  434. <for each="item" in="member.see">
  435. <dd>{+ new Link().toSymbol(item) +}</dd>
  436. </for>
  437. </dl>
  438. </if>
  439. <if test="!$member_last"><hr /></if>
  440. </for>
  441. </if>
  442. <hr />
  443. </div>
  444. <!-- ============================== footer ================================= -->
  445. <div class="fineprint" style="clear:both">
  446. <if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
  447. Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
  448. </div>
  449. </body>
  450. </html>