class.tmpl 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  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>glMatrix - {+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. <div class="wrapper">
  19. <!-- ============================== classes index ============================ -->
  20. <header id="index">
  21. <!-- begin publish.classesIndex -->
  22. {+publish.classesIndex+}
  23. <!-- end publish.classesIndex -->
  24. </header>
  25. <section id="content">
  26. <!-- ============================== class title ============================ -->
  27. <h1 class="classTitle">
  28. {!
  29. var classType = "";
  30. if (data.isBuiltin()) {
  31. classType += "Built-In ";
  32. }
  33. if (data.isNamespace) {
  34. if (data.is('FUNCTION')) {
  35. classType += "Function ";
  36. }
  37. classType += "Namespace ";
  38. }
  39. else {
  40. classType += "Class ";
  41. }
  42. !}
  43. {+classType+}{+data.alias+}
  44. </h1>
  45. <!-- ============================== class summary ========================== -->
  46. <p class="description">
  47. <if test="data.version"><br />Version
  48. {+ data.version +}.<br />
  49. </if>
  50. <if test="data.augments.length"><br />Extends
  51. {+
  52. data.augments
  53. .sort()
  54. .map(
  55. function($) { return new Link().toSymbol($); }
  56. )
  57. .join(", ")
  58. +}.<br />
  59. </if>
  60. {+resolveLinks(data.classDesc)+}
  61. <if test="data.desc">
  62. <div class="description">{+resolveLinks(summarize(data.desc))+}</div>
  63. </if>
  64. <if test="!data.isBuiltin()">{# isn't defined in any file #}
  65. <br /><i>Defined in: </i> {+new Link().toSrc(data.srcFile)+}.
  66. </if>
  67. </p>
  68. <!-- ============================== properties summary ===================== -->
  69. <if test="data.properties.length">
  70. {! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
  71. <if test="ownProperties.length">
  72. <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}.">
  73. <caption>Field Summary</caption>
  74. <thead>
  75. <tr>
  76. <th scope="col">Field Attributes</th>
  77. <th scope="col">Field Name and Description</th>
  78. </tr>
  79. </thead>
  80. <tbody>
  81. <for each="member" in="ownProperties">
  82. <tr>
  83. <td class="attributes">{!
  84. if (member.isPrivate) output += "&lt;private&gt; ";
  85. if (member.isInner) output += "&lt;inner&gt; ";
  86. if (member.isStatic) output += "&lt;static&gt; ";
  87. if (member.isConstant) output += "&lt;constant&gt; ";
  88. !}&nbsp;</td>
  89. <td class="nameDescription">
  90. <div class="fixedFont">
  91. <if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>
  92. </div>
  93. <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
  94. </td>
  95. </tr>
  96. </for>
  97. </tbody>
  98. </table>
  99. </if>
  100. <if test="data.inheritsFrom.length">
  101. <dl class="inheritsList">
  102. {!
  103. var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
  104. var contributers = [];
  105. borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
  106. for (var i = 0, l = contributers.length; i < l; i++) {
  107. output +=
  108. "<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
  109. +
  110. "<dd>" +
  111. borrowedMembers
  112. .filter(
  113. function($) { return $.memberOf == contributers[i] }
  114. )
  115. .sort(makeSortby("name"))
  116. .map(
  117. function($) { return new Link().toSymbol($.alias).withText($.name) }
  118. )
  119. .join(", ")
  120. +
  121. "</dd>";
  122. }
  123. !}
  124. </dl>
  125. </if>
  126. </if>
  127. <!-- ============================== methods summary ======================== -->
  128. <if test="data.methods.length">
  129. {! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
  130. <if test="ownMethods.length">
  131. <h2>Methods</h2>
  132. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}.">
  133. <tbody>
  134. <for each="member" in="ownMethods">
  135. <tr>
  136. <td class="nameDescription">
  137. <code class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+}
  138. </code>
  139. <div class="description">{+resolveLinks(summarize(member.desc))+}</div>
  140. </td>
  141. </tr>
  142. </for>
  143. </tbody>
  144. </table>
  145. </if>
  146. </if>
  147. <!-- ============================== field details ========================== -->
  148. <if test="defined(ownProperties) && ownProperties.length">
  149. <div class="sectionTitle">
  150. Field Detail
  151. </div>
  152. <for each="member" in="ownProperties">
  153. <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
  154. <div class="fixedFont">{!
  155. if (member.isPrivate) output += "&lt;private&gt; ";
  156. if (member.isInner) output += "&lt;inner&gt; ";
  157. if (member.isStatic) output += "&lt;static&gt; ";
  158. if (member.isConstant) output += "&lt;constant&gt; ";
  159. !}
  160. <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
  161. <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>
  162. </div>
  163. <div class="description">
  164. {+resolveLinks(member.desc)+}
  165. <if test="member.srcFile != data.srcFile">
  166. <br />
  167. <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
  168. </if>
  169. <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
  170. </div>
  171. <if test="member.example.length">
  172. <for each="example" in="member.example">
  173. <pre class="code">{+example+}</pre>
  174. </for>
  175. </if>
  176. <if test="member.deprecated">
  177. <dl class="detailList">
  178. <dt class="heading">Deprecated:</dt>
  179. <dt>
  180. {+ resolveLinks(member.deprecated) +}
  181. </dt>
  182. </dl>
  183. </if>
  184. <if test="member.since">
  185. <dl class="detailList">
  186. <dt class="heading">Since:</dt>
  187. <dd>{+ member.since +}</dd>
  188. </dl>
  189. </if>
  190. <if test="member.see.length">
  191. <dl class="detailList">
  192. <dt class="heading">See:</dt>
  193. <for each="item" in="member.see">
  194. <dd>{+ new Link().toSymbol(item) +}</dd>
  195. </for>
  196. </dl>
  197. </if>
  198. <if test="member.defaultValue">
  199. <dl class="detailList">
  200. <dt class="heading">Default Value:</dt>
  201. <dd>
  202. {+resolveLinks(member.defaultValue)+}
  203. </dd>
  204. </dl>
  205. </if>
  206. <if test="!$member_last"><hr /></if>
  207. </for>
  208. </if>
  209. <!-- ============================== method details ========================= -->
  210. <if test="defined(ownMethods) && ownMethods.length">
  211. <h2>Method Detail</h2>
  212. <for each="member" in="ownMethods">
  213. <a name="{+Link.symbolNameToLinkName(member)+}"> </a>
  214. <h3 class="fixedFont">
  215. <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
  216. <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+}
  217. </h3>
  218. <div style="margin-left: 1em;">
  219. <p class="description">
  220. {+resolveLinks(member.desc)+}
  221. <if test="member.srcFile != data.srcFile">
  222. <br />
  223. <i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
  224. </if>
  225. <if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
  226. </p>
  227. <if test="member.example.length">
  228. <for each="example" in="member.example">
  229. <pre class="code">{+example+}</pre>
  230. </for>
  231. </if>
  232. <if test="member.params.length">
  233. <dl class="detailList">
  234. <dt class="heading">Parameters:</dt>
  235. <for each="item" in="member.params">
  236. <dt>
  237. {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
  238. <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
  239. </dt>
  240. <dd>{+resolveLinks(item.desc)+}</dd>
  241. </for>
  242. </dl>
  243. </if>
  244. <if test="member.deprecated">
  245. <dl class="detailList">
  246. <dt class="heading">Deprecated:</dt>
  247. <dt>
  248. {+ resolveLinks(member.deprecated) +}
  249. </dt>
  250. </dl>
  251. </if>
  252. <if test="member.since">
  253. <dl class="detailList">
  254. <dt class="heading">Since:</dt>
  255. <dd>{+ member.since +}</dd>
  256. </dl>
  257. </dl>
  258. </if>
  259. <if test="member.exceptions.length">
  260. <dl class="detailList">
  261. <dt class="heading">Throws:</dt>
  262. <for each="item" in="member.exceptions">
  263. <dt>
  264. {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
  265. </dt>
  266. <dd>{+resolveLinks(item.desc)+}</dd>
  267. </for>
  268. </dl>
  269. </if>
  270. <if test="member.returns.length">
  271. <dl class="detailList">
  272. <dt class="heading">Returns:</dt>
  273. <for each="item" in="member.returns">
  274. <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
  275. </for>
  276. </dl>
  277. </if>
  278. <if test="member.requires.length">
  279. <dl class="detailList">
  280. <dt class="heading">Requires:</dt>
  281. <for each="item" in="member.requires">
  282. <dd>{+ resolveLinks(item) +}</dd>
  283. </for>
  284. </dl>
  285. </if>
  286. <if test="member.see.length">
  287. <dl class="detailList">
  288. <dt class="heading">See:</dt>
  289. <for each="item" in="member.see">
  290. <dd>{+ new Link().toSymbol(item) +}</dd>
  291. </for>
  292. </dl>
  293. </if>
  294. <if test="!$member_last"><hr /></if>
  295. </div>
  296. </for>
  297. </if>
  298. <hr />
  299. </section>
  300. <!-- ============================== footer ================================= -->
  301. <footer>
  302. <small>
  303. <if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
  304. Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}
  305. <br/><br/>
  306. Theme based on Github Pages template by <a href="https://github.com/orderedlist">orderedlist</a>
  307. </small>
  308. </footer>
  309. </div>
  310. </body>
  311. </html>