Skip to content
This repository
Newer
Older
100644 432 lines (376 sloc) 15.023 kb
03adcda8 »
2012-09-11 appledoc now embeds the default templates, installing them on demand …
1 <!DOCTYPE HTML>
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
5 <title>{{page/title}}</title>
6 <meta id="xcode-display" name="xcode-display" content="render"/>
7 <meta name="viewport" content="width=550" />
8 <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
9 <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
10 {{#strings/appledocData}}<meta name="generator" content="{{tool}} {{version}} (build {{build}})" />{{/strings/appledocData}}
11 </head>
12 <body>
13 <header id="top_header">
14 <div id="library" class="hideInXcode">
15 {{#page}}<h1><a id="libraryTitle" href="../index.html">{{projectName}} {{strings/objectPage/libraryTitlePostfix}}</a></h1>
16 <a id="developerHome" href="../index.html">{{projectCompany}}</a>{{/page}}
17 </div>
18
19 <div id="title" role="banner">
20 <h1 class="hideInXcode">{{page/title}}</h1>
21 </div>
22 <ul id="headerButtons" role="toolbar">
23 <li id="toc_button">
24 <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
25 </li>
26 <li id="jumpto_button" role="navigation">
27 {{>JumpTo}}
28 </li>
29 </ul>
30 </header>
31 <nav id="tocContainer" class="isShowingTOC">
32 <ul id="toc" role="tree">
33 {{>TableOfContents}}
34 </ul>
35 </nav>
36 <article>
37 <div id="contents" class="isShowingTOC" role="main">
38 <a title="{{page/title}}" name="top"></a>
39 <div class="main-navigation navigation-top">
40 {{>Navigation}}
41 </div>
42 <div id="header">
43 <div class="section-header">
44 <h1 class="title title-header">{{page/title}}</h1>
45 </div>
46 </div>
47 <div id="container">
48 {{#page/specifications}}
49 {{#used}}<div class="section section-specification"><table cellspacing="0"><tbody>{{/used}}
50 {{#values}}{{>ObjectSpecification}}{{/values}}
51 {{#used}}</tbody></table></div>{{/used}}
52 {{/page/specifications}}
53
54 {{#object/comment}}
55 {{#hasLongDescription}}
56 <div class="section section-overview">
57 <a title="{{strings/objectOverview/title}}" name="overview"></a>
58 <h2 class="subtitle subtitle-overview">{{strings/objectOverview/title}}</h2>
59 {{#longDescription}}{{>GBCommentComponentsList}}{{/longDescription}}
60 </div>
61 {{/hasLongDescription}}
62 {{/object/comment}}
63
64 {{#object/methods}}
65 {{#hasSections}}
66 <div class="section section-tasks">
67 <a title="{{strings/objectTasks/title}}" name="tasks"></a>
68 <h2 class="subtitle subtitle-tasks">{{strings/objectTasks/title}}</h2>
69 {{#sections}}
70
71 {{#sectionName}}<a title="{{#sectionName}}{{.}}{{/sectionName}}" name="task_{{#sectionName}}{{.}}{{/sectionName}}"></a>{{/sectionName}}
72 {{>TaskTitle}}
73 <ul class="task-list">
74 {{#methods}}{{>TaskMethod}}{{/methods}}
75 </ul>
76 {{/sections}}
77 </div>
78 {{/hasSections}}
79 {{/object/methods}}
80
81 {{#object/methods}}
82 {{#hasProperties}}
83 <div class="section section-methods">
84 <a title="{{strings/objectMethods/propertiesTitle}}" name="properties"></a>
85 <h2 class="subtitle subtitle-methods">{{strings/objectMethods/propertiesTitle}}</h2>
86 {{#properties}}
87 {{>Method}}
88 {{/properties}}
89 </div>
90 {{/hasProperties}}
91
92 {{#hasClassMethods}}
93 <div class="section section-methods">
94 <a title="{{strings/objectMethods/classMethodsTitle}}" name="class_methods"></a>
95 <h2 class="subtitle subtitle-methods">{{strings/objectMethods/classMethodsTitle}}</h2>
96 {{#classMethods}}
97 {{>Method}}
98 {{/classMethods}}
99 </div>
100 {{/hasClassMethods}}
101
102 {{#hasInstanceMethods}}
103 <div class="section section-methods">
104 <a title="{{strings/objectMethods/instanceMethodsTitle}}" name="instance_methods"></a>
105 <h2 class="subtitle subtitle-methods">{{strings/objectMethods/instanceMethodsTitle}}</h2>
106 {{#instanceMethods}}
107 {{>Method}}
108 {{/instanceMethods}}
109 </div>
110 {{/hasInstanceMethods}}
111 {{/object/methods}}
112 </div>
113 <div class="main-navigation navigation-bottom">
114 {{>Navigation}}
115 </div>
116 <div id="footer">
117 <hr />
118 <div class="footer-copyright">
119 {{#page}}<p><span class="copyright">&copy; {{copyrightDate}} {{copyrightHolder}}. All rights reserved. (Last updated: {{lastUpdatedDate}})</span>{{/page}}<br />
120 {{#strings/appledocData}}
121 <span class="generator">Generated by <a href="{{homepage}}">{{tool}} {{version}} (build {{build}})</a>.</span></p>
122 {{/strings/appledocData}}
123 </div>
124 </div>
125 </div>
126 </article>
127 <script type="text/javascript">
128 function jumpToChange()
129 {
130 window.location.hash = this.options[this.selectedIndex].value;
131 }
132
133 function toggleTOC()
134 {
135 var contents = document.getElementById('contents');
136 var tocContainer = document.getElementById('tocContainer');
137
138 if (this.getAttribute('class') == 'open')
139 {
140 this.setAttribute('class', '');
141 contents.setAttribute('class', '');
142 tocContainer.setAttribute('class', '');
143
144 window.name = "hideTOC";
145 }
146 else
147 {
148 this.setAttribute('class', 'open');
149 contents.setAttribute('class', 'isShowingTOC');
150 tocContainer.setAttribute('class', 'isShowingTOC');
151
152 window.name = "";
153 }
154 return false;
155 }
156
157 function toggleTOCEntryChildren(e)
158 {
159 e.stopPropagation();
160 var currentClass = this.getAttribute('class');
161 if (currentClass == 'children') {
162 this.setAttribute('class', 'children open');
163 }
164 else if (currentClass == 'children open') {
165 this.setAttribute('class', 'children');
166 }
167 return false;
168 }
169
170 function tocEntryClick(e)
171 {
172 e.stopPropagation();
173 return true;
174 }
175
176 function init()
177 {
178 var selectElement = document.getElementById('jumpTo');
179 selectElement.addEventListener('change', jumpToChange, false);
180
181 var tocButton = document.getElementById('table_of_contents');
182 tocButton.addEventListener('click', toggleTOC, false);
183
184 var taskTreeItem = document.getElementById('task_treeitem');
185 if (taskTreeItem.getElementsByTagName('li').length > 0)
186 {
187 taskTreeItem.setAttribute('class', 'children');
188 taskTreeItem.firstChild.setAttribute('class', 'disclosure');
189 }
190
191 var tocList = document.getElementById('toc');
192
193 var tocEntries = tocList.getElementsByTagName('li');
194 for (var i = 0; i < tocEntries.length; i++) {
195 tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
196 }
197
198 var tocLinks = tocList.getElementsByTagName('a');
199 for (var i = 0; i < tocLinks.length; i++) {
200 tocLinks[i].addEventListener('click', tocEntryClick, false);
201 }
202
203 if (window.name == "hideTOC") {
204 toggleTOC.call(tocButton);
205 }
206 }
207
208 window.onload = init;
209
210 // If showing in Xcode, hide the TOC and Header
211 if (navigator.userAgent.match(/xcode/i)) {
212 document.getElementById("contents").className = "hideInXcode"
213 document.getElementById("tocContainer").className = "hideInXcode"
214 document.getElementById("top_header").className = "hideInXcode"
215 }
216
217 </script>
218 </body>
219 </html>
220
221
222 Section Method
223 <div class="section-method">
224 <a name="{{htmlReferenceName}}" title="{{methodSelector}}"></a>
225 <h3 class="subsubtitle method-title">{{methodSelector}}</h3>
226
227 {{#comment}}
228 {{#hasShortDescription}}
229 <div class="method-subsection brief-description">
230 {{#shortDescription}}{{>GBCommentComponent}}{{/shortDescription}}
231 </div>
232 {{/hasShortDescription}}
233 {{/comment}}
234
235 <div class="method-subsection method-declaration"><code>{{>MethodDeclaration}}</code></div>
236
237 {{#comment}}
238 {{#hasMethodParameters}}
239 <div class="method-subsection arguments-section parameters">
240 <h4 class="method-subtitle parameter-title">{{strings/objectMethods/parametersTitle}}</h4>
241 {{#methodParameters}}
242 <dl class="argument-def parameter-def">
243 <dt><em>{{argumentName}}</em></dt>
244 <dd>{{#argumentDescription}}{{>GBCommentComponentsList}}{{/argumentDescription}}</dd>
245 </dl>
246 {{/methodParameters}}
247 </div>
248 {{/hasMethodParameters}}
249
250 {{#hasMethodResult}}
251 <div class="method-subsection return">
252 <h4 class="method-subtitle parameter-title">{{strings/objectMethods/resultTitle}}</h4>
253 {{#methodResult}}{{>GBCommentComponentsList}}{{/methodResult}}
254 </div>
255 {{/hasMethodResult}}
256
257 {{#hasAvailability}}
258 <div class="method-subsection availability">
259 <h4 class="method-subtitle parameter-title">{{strings/objectMethods/availability}}</h4>
260 {{#availability}}{{>GBCommentComponentsList}}{{/availability}}
261 </div>
262 {{/hasAvailability}}
263
264 {{#hasLongDescription}}
265 <div class="method-subsection discussion-section">
266 <h4 class="method-subtitle">{{strings/objectMethods/discussionTitle}}</h4>
267 {{#longDescription}}{{>GBCommentComponentsList}}{{/longDescription}}
268 </div>
269 {{/hasLongDescription}}
270
271 {{#hasMethodExceptions}}
272 <div class="method-subsection arguments-section exceptions">
273 <h4 class="method-subtitle exception-title">{{strings/objectMethods/exceptionsTitle}}</h4>
274 {{#methodExceptions}}
275 <dl class="argument-def exception-def">
276 <dt><em>{{argumentName}}</em></dt>
277 <dd>{{#argumentDescription}}{{>GBCommentComponentsList}}{{/argumentDescription}}</dd>
278 </dl>
279 {{/methodExceptions}}
280 </div>
281 {{/hasMethodExceptions}}
282
283 {{#hasRelatedItems}}
284 <div class="method-subsection see-also-section">
285 <h4 class="method-subtitle">{{strings/objectMethods/seeAlsoTitle}}</h4>
286 <ul>
287 {{#relatedItems/components}}
288 <li><code>{{>GBCommentComponent}}</code></li>
289 {{/relatedItems/components}}
290 </ul>
291 </div>
292 {{/hasRelatedItems}}
293
294 {{#prefferedSourceInfo}}
295 <div class="method-subsection declared-in-section">
296 <h4 class="method-subtitle">{{strings/objectMethods/declaredInTitle}}</h4>
297 <code class="declared-in-ref">{{filename}}</code><br />
298 </div>
299 {{/prefferedSourceInfo}}
300 {{/comment}}
301 </div>
302 EndSection
303
304 Section MethodDeclaration
305 {{#formattedComponents}}{{#emphasized}}<em>{{/emphasized}}{{#href}}<a href="{{&href}}">{{/href}}{{value}}{{#href}}</a>{{/href}}{{#emphasized}}</em>{{/emphasized}}{{/formattedComponents}}
306 EndSection
307
308
309 Section TaskTitle
310 {{#hasMultipleSections}}<h3 class="subsubtitle task-title">{{#sectionName}}{{.}}{{/sectionName}}{{^sectionName}}{{strings/objectTasks/otherMethodsSectionName}}{{/sectionName}}</h3>{{/hasMultipleSections}}
311 {{^hasMultipleSections}}{{#sectionName}}<h3 class="subsubtitle task-title">{{.}}</h3>{{/sectionName}}{{/hasMultipleSections}}
312 EndSection
313
314 Section TaskMethod
315 <li>
316 <span class="tooltip">
317 <code><a href="{{htmlLocalReference}}">{{>TaskSelector}}</a></code>
318 {{#comment}}{{#hasShortDescription}}<span class="tooltip">{{#shortDescription}}{{>GBCommentComponent}}{{/shortDescription}}</span>{{/hasShortDescription}}{{/comment}}
319 </span>
320 {{#isProperty}}<span class="task-item-suffix">{{strings/objectTasks/property}}</span>{{/isProperty}}
321 {{#isRequired}}<span class="task-item-suffix">{{strings/objectTasks/requiredMethod}}</span>{{/isRequired}}
322 </li>
323 EndSection
324
325 Section TaskSelector
326 {{#isInstanceMethod}}&ndash;&nbsp;{{/isInstanceMethod}}{{#isClassMethod}}+&nbsp;{{/isClassMethod}}{{#isProperty}}&nbsp;&nbsp;{{/isProperty}}{{methodSelector}}
327 EndSection
328
329
330 Section GBCommentComponentsList
331 {{#components}}{{>GBCommentComponent}}{{/components}}
332 EndSection
333
334 Section GBCommentComponent
335 {{&htmlValue}}
336 EndSection
337
338 Section ObjectSpecification
339 <tr>
340 <td class="specification-title">{{title}}</td>
341 <td class="specification-value">{{#values}}{{#href}}<a href="{{&href}}">{{/href}}{{string}}{{#href}}</a>{{/href}}{{&delimiter}}{{/values}}</td>
342 </tr>
343 EndSection
344
345
346 Section Navigation
347 <ul>
348 <li><a href="../index.html">Index</a></li>
349 <li><a href="../hierarchy.html">Hierarchy</a></li>
350 </ul>
351 EndSection
352
353 Section JumpTo
354 <select id="jumpTo">
355 <option value="top">Jump To&#133;</option>
356 {{#object/comment}}
357 <option value="overview">{{strings/objectOverview/title}}</option>
358 {{/object/comment}}
359
360 {{#object/methods}}
361 {{#hasSections}}
362 <option value="tasks">{{strings/objectTasks/title}}</option>
363 {{/hasSections}}
364 {{/object/methods}}
365
366 {{#object/methods}}
367 {{#hasProperties}}
368 <option value="properties">{{strings/objectMethods/propertiesTitle}}</option>
369 {{#properties}}
370 <option value="{{htmlReferenceName}}">&nbsp;&nbsp;&nbsp;&nbsp;{{methodSelector}}</option>
371 {{/properties}}
372 {{/hasProperties}}
373
374 {{#hasClassMethods}}
375 <option value="class_methods">{{strings/objectMethods/classMethodsTitle}}</option>
376 {{#classMethods}}
377 <option value="{{htmlReferenceName}}">&nbsp;&nbsp;&nbsp;&nbsp;{{prefixedMethodSelector}}</option>
378 {{/classMethods}}
379 {{/hasClassMethods}}
380
381 {{#hasInstanceMethods}}
382 <option value="instance_methods">{{strings/objectMethods/instanceMethodsTitle}}</option>
383 {{#instanceMethods}}
384 <option value="{{htmlReferenceName}}">&nbsp;&nbsp;&nbsp;&nbsp;{{prefixedMethodSelector}}</option>
385 {{/instanceMethods}}
386 {{/hasInstanceMethods}}
387 {{/object/methods}}
388 </select>
389 EndSection
390
391 Section TableOfContents
392 {{#object/comment}}
393 <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">{{strings/objectOverview/title}}</a></span></li>
394 {{/object/comment}}
395
396 {{#object/methods}}
397 {{#hasSections}}
398 <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">{{strings/objectTasks/title}}</a></span><ul>
399 {{#sections}}{{#sectionName}}
400 <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_{{#sectionName}}{{.}}{{/sectionName}}">{{#sectionName}}{{.}}{{/sectionName}}</a></span></li>
401 {{/sectionName}}{{/sections}}
402 </ul></li>
403 {{/hasSections}}
404 {{/object/methods}}
405
406 {{#object/methods}}
407 {{#hasProperties}}
408 <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">{{strings/objectMethods/propertiesTitle}}</a></span><ul>
409 {{#properties}}
410 <li><span class="nodisclosure"></span><span class="sectionName"><a href="#{{htmlReferenceName}}">{{methodSelector}}</a></span></li>
411 {{/properties}}
412 </ul></li>
413 {{/hasProperties}}
414
415 {{#hasClassMethods}}
416 <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">{{strings/objectMethods/classMethodsTitle}}</a></span><ul>
417 {{#classMethods}}
418 <li><span class="nodisclosure"></span><span class="sectionName"><a href="#{{htmlReferenceName}}">{{methodSelector}}</a></span></li>
419 {{/classMethods}}
420 </ul></li>
421 {{/hasClassMethods}}
422
423 {{#hasInstanceMethods}}
424 <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">{{strings/objectMethods/instanceMethodsTitle}}</a></span><ul>
425 {{#instanceMethods}}
426 <li><span class="nodisclosure"></span><span class="sectionName"><a href="#{{htmlReferenceName}}">{{methodSelector}}</a></span></li>
427 {{/instanceMethods}}
428 </ul></li>
429 {{/hasInstanceMethods}}
430 {{/object/methods}}
431 EndSection
Something went wrong with that request. Please try again.