OLD | NEW |
| (Empty) |
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 | |
10 <style type="text/css"> | |
11 {+include("static/default.css")+} | |
12 </style> | |
13 </head> | |
14 | |
15 <body> | |
16 <!-- ============================== header ================================= -->
| |
17 <!-- begin static/header.html --> | |
18 {+include("static/header.html")+} | |
19 <!-- end static/header.html --> | |
20 | |
21 <div class="wrapper"> | |
22 <!-- ============================== classes index ============================ -
-> | |
23 <header id="index"> | |
24 <!-- begin publish.classesIndex --> | |
25 {+publish.classesIndex+} | |
26 <!-- end publish.classesIndex --> | |
27 </header> | |
28 | |
29 <section id="content"> | |
30 <!-- ============================== class title ============================ --> | |
31 <h1 class="classTitle"> | |
32 {! | |
33 var classType = ""; | |
34 | |
35 if (data.isBuiltin()) { | |
36 classType += "Built-In "; | |
37 } | |
38 | |
39 if (data.isNamespace) { | |
40 if (data.is('FUNCTION')) { | |
41 classType += "Function "
; | |
42 } | |
43 classType += "Namespace "; | |
44 } | |
45 else { | |
46 classType += "Class "; | |
47 } | |
48 !} | |
49 {+classType+}{+data.alias+} | |
50 </h1> | |
51 | |
52 <!-- ============================== class summary ========================== -->
| |
53 <p class="description"> | |
54 <if test="data.version"><br />Version | |
55 {+ data.version +}.<br /> | |
56 </if> | |
57 <if test="data.augments.length"><br />Extends | |
58 {+ | |
59 data.augments | |
60 .sort() | |
61 .map( | |
62 function($) { return new
Link().toSymbol($); } | |
63 ) | |
64 .join(", ") | |
65 +}.<br /> | |
66 </if> | |
67 | |
68 {+resolveLinks(data.classDesc)+} | |
69 | |
70 <if test="data.desc"> | |
71 <div class="description">{+resolveLinks(
summarize(data.desc))+}</div> | |
72 </if> | |
73 | |
74 <if test="!data.isBuiltin()">{# isn't defined in
any file #} | |
75 <br /><i>Defined in: </i> {+new Link().t
oSrc(data.srcFile)+}. | |
76 </if> | |
77 </p> | |
78 | |
79 <!-- ============================== properties summary ===================== --> | |
80 <if test="data.properties.length"> | |
81 {! var ownProperties = data.properties.filter(fu
nction($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("n
ame")); !} | |
82 <if test="ownProperties.length"> | |
83 <table class="summaryTable" cellspacing="0" summ
ary="A summary of the fields documented in the class {+data.alias+}."> | |
84 <caption>Field Summary</caption> | |
85 <thead> | |
86 <tr> | |
87 <th scope="col">Field At
tributes</th> | |
88 <th scope="col">Field Na
me and Description</th> | |
89 </tr> | |
90 </thead> | |
91 <tbody> | |
92 <for each="member" in="ownProperties"> | |
93 <tr> | |
94 <td class="attributes">{
! | |
95 if (member.isPri
vate) output += "<private> "; | |
96 if (member.isInn
er) output += "<inner> "; | |
97 if (member.isSta
tic) output += "<static> "; | |
98 if (member.isCon
stant) output += "<constant> "; | |
99 !} </td> | |
100 <td class="nameDescripti
on"> | |
101 <div class="fixe
dFont"> | |
102 <if test="member
.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Li
nk().toSymbol(member.alias).withText(member.name)+}</b> | |
103 </div> | |
104 <div class="desc
ription">{+resolveLinks(summarize(member.desc))+}</div> | |
105 </td> | |
106 </tr> | |
107 </for> | |
108 </tbody> | |
109 </table> | |
110 </if> | |
111 | |
112 <if test="data.inheritsFrom.length"> | |
113 <dl class="inheritsList"> | |
114 {! | |
115 var borrowedMembers = data.properties.fi
lter(function($) {return $.memberOf != data.alias}); | |
116 | |
117 var contributers = []; | |
118 borrowedMembers.map(function($) {if (con
tributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)}); | |
119 for (var i = 0, l = contributers.length;
i < l; i++) { | |
120 output += | |
121 "<dt>Fields borrowed fro
m class "+new Link().toSymbol(contributers[i])+": </dt>" | |
122 + | |
123 "<dd>" + | |
124 borrowedMembers | |
125 .filter( | |
126 function($) { re
turn $.memberOf == contributers[i] } | |
127 ) | |
128 .sort(makeSortby("name")
) | |
129 .map( | |
130 function($) { re
turn new Link().toSymbol($.alias).withText($.name) } | |
131 ) | |
132 .join(", ") | |
133 + | |
134 "</dd>"; | |
135 } | |
136 !} | |
137 </dl> | |
138 </if> | |
139 </if> | |
140 | |
141 <!-- ============================== methods summary ======================== --> | |
142 <if test="data.methods.length"> | |
143 {! var ownMethods = data.methods.filter(function
($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")
); !} | |
144 <if test="ownMethods.length"> | |
145 <h2>Methods</h2> | |
146 <table class="summaryTable" cellspacing="0" summ
ary="A summary of the methods documented in the class {+data.alias+}."> | |
147 <tbody> | |
148 <for each="member" in="ownMethods"> | |
149 <tr> | |
150 <td class="nameDescripti
on"> | |
151 <code class="fix
edFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.mem
berOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace
(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+} | |
152 </code> | |
153 <div class="desc
ription">{+resolveLinks(summarize(member.desc))+}</div> | |
154 </td> | |
155 </tr> | |
156 </for> | |
157 </tbody> | |
158 </table> | |
159 </if> | |
160 </if> | |
161 | |
162 <!-- ============================== field details ========================== -->
| |
163 <if test="defined(ownProperties) && ownProperties.length
"> | |
164 <div class="sectionTitle"> | |
165 Field Detail | |
166 </div> | |
167 <for each="member" in="ownProperties"> | |
168 <a name="{+Link.symbolNameToLinkName(mem
ber)+}"> </a> | |
169 <div class="fixedFont">{! | |
170 if (member.isPrivate) output +=
"<private> "; | |
171 if (member.isInner) output += "&
lt;inner> "; | |
172 if (member.isStatic) output += "
<static> "; | |
173 if (member.isConstant) output +=
"<constant> "; | |
174 !} | |
175 | |
176 <if test="member.type"><span class="ligh
t">{{+new Link().toSymbol(member.type)+}}</span></if> | |
177 <if test="member.isStatic && member.memb
erOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+mem
ber.name+}</b> | |
178 | |
179 </div> | |
180 <div class="description"> | |
181 {+resolveLinks(member.desc)+} | |
182 <if test="member.srcFile != data
.srcFile"> | |
183 <br /> | |
184 <i>Defined in: </i> {+ne
w Link().toSrc(member.srcFile)+}. | |
185 </if> | |
186 <if test="member.author"><br /><
i>Author: </i>{+member.author+}.</if> | |
187 </div> | |
188 | |
189 <if test="member.example.length"> | |
190 <for each="example" in="member.example"> | |
191 <pre class="code">{+example+}</pre> | |
192 </for> | |
193 </if> | |
194 | |
195 <if test="member.deprecated"> | |
196 <dl class="detailList"> | |
197 <dt class="heading">Depr
ecated:</dt> | |
198 <dt> | |
199 {+ resolveLinks(
member.deprecated) +} | |
200 </dt> | |
201 </dl> | |
202 </if> | |
203 <if test="member.since"> | |
204 <dl class="detailList"> | |
205 <dt class="heading">Sinc
e:</dt> | |
206 <dd>{+ member.si
nce +}</dd> | |
207 </dl> | |
208 </if> | |
209 <if test="member.see.length"> | |
210 <dl class="detailList"> | |
211 <dt class="heading">See:
</dt> | |
212 <for each="item" in="mem
ber.see"> | |
213 <dd>{+ new Link().toSymb
ol(item) +}</dd> | |
214 </for> | |
215 </dl> | |
216 </if> | |
217 <if test="member.defaultValue"> | |
218 <dl class="detailList"> | |
219 <dt class="heading">Defa
ult Value:</dt> | |
220 <dd> | |
221 {+resolveLinks(m
ember.defaultValue)+} | |
222 </dd> | |
223 </dl> | |
224 </if> | |
225 | |
226 <if test="!$member_last"><hr /></if> | |
227 </for> | |
228 </if> | |
229 | |
230 <!-- ============================== method details ========================= -->
| |
231 <if test="defined(ownMethods) && ownMethods.length"> | |
232 <h2>Method Detail</h2> | |
233 <for each="member" in="ownMethods"> | |
234 <a name="{+Link.symbolNameToLinkName(mem
ber)+}"> </a> | |
235 <h3 class="fixedFont"> | |
236 <if test="member.type"><span class="ligh
t">{{+new Link().toSymbol(member.type)+}}</span></if> | |
237 <if test="member.isStatic && member.memb
erOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+mem
ber.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+} | |
238 </h3> | |
239 | |
240 <div style="margin-left: 1em;"> | |
241 <p class="description"> | |
242 {+resolveLinks(member.de
sc)+} | |
243 <if test="member.srcFile
!= data.srcFile"> | |
244 <br /> | |
245 <i>Defined in: <
/i> {+new Link().toSrc(member.srcFile)+}. | |
246 </if> | |
247 <if test="member.author"
><br /><i>Author: </i>{+member.author+}.</if> | |
248 </p> | |
249 | |
250 <if test="member.example.length"
> | |
251 <for each="example" in="member.e
xample"> | |
252 <pre class="code">{+example+}</p
re> | |
253 </for> | |
254 </if> | |
255 | |
256 <if test="member.params.
length"> | |
257 <dl class="detai
lList"> | |
258 <dt class="headi
ng">Parameters:</dt> | |
259 <for each="item"
in="member.params"> | |
260 <dt> | |
261
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.typ
e))+"}</span> " : "")+}<b>{+item.name+}</b> | |
262
<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+
item.defaultValue+}</if></i></if> | |
263 </dt> | |
264 <dd>{+re
solveLinks(item.desc)+}</dd> | |
265 </for> | |
266 </dl> | |
267 </if> | |
268 <if test="member.depreca
ted"> | |
269 <dl class="detai
lList"> | |
270 <dt class="headi
ng">Deprecated:</dt> | |
271 <dt> | |
272 {+ resol
veLinks(member.deprecated) +} | |
273 </dt> | |
274 </dl> | |
275 </if> | |
276 <if test="member.since"> | |
277 <dl class="detai
lList"> | |
278 <dt class="headi
ng">Since:</dt> | |
279 <dd>{+ m
ember.since +}</dd> | |
280 </dl> | |
281 </dl> | |
282 </if> | |
283 <if test="member.excepti
ons.length"> | |
284 <dl class="detai
lList"> | |
285 <dt class="headi
ng">Throws:</dt> | |
286 <for each="item"
in="member.exceptions"> | |
287 <dt> | |
288
{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.typ
e))+"}</span> " : "")+} <b>{+item.name+}</b> | |
289 </dt> | |
290 <dd>{+re
solveLinks(item.desc)+}</dd> | |
291 </for> | |
292 </dl> | |
293 </if> | |
294 <if test="member.returns
.length"> | |
295 <dl class="detai
lList"> | |
296 <dt class="headi
ng">Returns:</dt> | |
297 <for each="item"
in="member.returns"> | |
298 <dd>{+((
item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+
"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd> | |
299 </for> | |
300 </dl> | |
301 </if> | |
302 <if test="member.require
s.length"> | |
303 <dl class="detai
lList"> | |
304 <dt class="headi
ng">Requires:</dt> | |
305 <for each="item"
in="member.requires"> | |
306 <dd>{+ r
esolveLinks(item) +}</dd> | |
307 </for> | |
308 </dl> | |
309 </if> | |
310 <if test="member.see.len
gth"> | |
311 <dl class="detai
lList"> | |
312 <dt class="headi
ng">See:</dt> | |
313 <for each="item"
in="member.see"> | |
314 <dd>{+ n
ew Link().toSymbol(item) +}</dd> | |
315 </for> | |
316 </dl> | |
317 </if> | |
318 | |
319 <if test="!$member_last"><hr /><
/if> | |
320 </div> | |
321 </for> | |
322 </if> | |
323 | |
324 <hr /> | |
325 </section> | |
326 | |
327 | |
328 <!-- ============================== footer ================================= --> | |
329 <footer> | |
330 <small> | |
331 <if test="JSDOC.opt.D.copyright">©{+JSDOC.o
pt.D.copyright+}<br /></if> | |
332 Documentation generated by <a href="http://code.
google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+}
on {+new Date()+} | |
333 <br/><br/> | |
334 Theme based on Github Pages template by <a href=
"https://github.com/orderedlist">orderedlist</a> | |
335 </small> | |
336 </footer> | |
337 | |
338 </div> | |
339 </body> | |
340 </html> | |
OLD | NEW |