Skip to content

Commit 47f505a

Browse files
BrettRToomeyBrettRToomey
committed
Updated documentation
1 parent 0cf822c commit 47f505a

File tree

186 files changed

+24835
-2007
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

186 files changed

+24835
-2007
lines changed

‎docs/Classes.html

Lines changed: 161 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<a title="Classes Reference"></a>
1414
<header>
1515
<div class="content-wrapper">
16-
<p><a href="index.html"> Docs</a> (100% documented)</p>
16+
<p><a href="index.html"> Docs</a> (99% documented)</p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
@@ -50,6 +50,18 @@
5050
<li class="nav-group-task">
5151
<a href="Classes/Module.html">Module</a>
5252
</li>
53+
<li class="nav-group-task">
54+
<a href="Classes/ObjectFile.html">ObjectFile</a>
55+
</li>
56+
<li class="nav-group-task">
57+
<a href="Classes/RelocationSequence.html">RelocationSequence</a>
58+
</li>
59+
<li class="nav-group-task">
60+
<a href="Classes/SectionSequence.html">SectionSequence</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="Classes/SymbolSequence.html">SymbolSequence</a>
64+
</li>
5365
<li class="nav-group-task">
5466
<a href="Classes/Target.html">Target</a>
5567
</li>
@@ -100,6 +112,9 @@
100112
<li class="nav-group-task">
101113
<a href="Enums/JITError.html">JITError</a>
102114
</li>
115+
<li class="nav-group-task">
116+
<a href="Enums/LandingPadClause.html">LandingPadClause</a>
117+
</li>
103118
<li class="nav-group-task">
104119
<a href="Enums/Linkage.html">Linkage</a>
105120
</li>
@@ -112,6 +127,12 @@
112127
<li class="nav-group-task">
113128
<a href="Enums/OpCode.html">OpCode</a>
114129
</li>
130+
<li class="nav-group-task">
131+
<a href="Enums/OpCode/Binary.html">– Binary</a>
132+
</li>
133+
<li class="nav-group-task">
134+
<a href="Enums/OpCode/Cast.html">– Cast</a>
135+
</li>
115136
<li class="nav-group-task">
116137
<a href="Enums/OverflowBehavior.html">OverflowBehavior</a>
117138
</li>
@@ -124,6 +145,9 @@
124145
<li class="nav-group-task">
125146
<a href="Enums.html#/s:O4LLVM6Signed">Signed</a>
126147
</li>
148+
<li class="nav-group-task">
149+
<a href="Enums/StorageClass.html">StorageClass</a>
150+
</li>
127151
<li class="nav-group-task">
128152
<a href="Enums/TargetMachineError.html">TargetMachineError</a>
129153
</li>
@@ -228,6 +252,9 @@
228252
<li class="nav-group-task">
229253
<a href="Structs/BasicBlock/Address.html">– Address</a>
230254
</li>
255+
<li class="nav-group-task">
256+
<a href="Structs/Call.html">Call</a>
257+
</li>
231258
<li class="nav-group-task">
232259
<a href="Structs/Constant.html">Constant</a>
233260
</li>
@@ -243,6 +270,9 @@
243270
<li class="nav-group-task">
244271
<a href="Structs/IntType.html">IntType</a>
245272
</li>
273+
<li class="nav-group-task">
274+
<a href="Structs/Invoke.html">Invoke</a>
275+
</li>
246276
<li class="nav-group-task">
247277
<a href="Structs/LabelType.html">LabelType</a>
248278
</li>
@@ -258,12 +288,24 @@
258288
<li class="nav-group-task">
259289
<a href="Structs/PointerType.html">PointerType</a>
260290
</li>
291+
<li class="nav-group-task">
292+
<a href="Structs/Relocation.html">Relocation</a>
293+
</li>
294+
<li class="nav-group-task">
295+
<a href="Structs/Section.html">Section</a>
296+
</li>
261297
<li class="nav-group-task">
262298
<a href="Structs/StructType.html">StructType</a>
263299
</li>
264300
<li class="nav-group-task">
265301
<a href="Structs/Switch.html">Switch</a>
266302
</li>
303+
<li class="nav-group-task">
304+
<a href="Structs/Symbol.html">Symbol</a>
305+
</li>
306+
<li class="nav-group-task">
307+
<a href="Structs/TerminatorInstruction.html">TerminatorInstruction</a>
308+
</li>
267309
<li class="nav-group-task">
268310
<a href="Structs/TokenType.html">TokenType</a>
269311
</li>
@@ -497,6 +539,122 @@ <h4>Declaration</h4>
497539
</li>
498540
</ul>
499541
</div>
542+
<div class="task-group">
543+
<ul>
544+
<li class="item">
545+
<div>
546+
<code>
547+
<a name="/s:C4LLVM10ObjectFile"></a>
548+
<a name="//apple_ref/swift/Class/ObjectFile" class="dashAnchor"></a>
549+
<a class="token" href="#/s:C4LLVM10ObjectFile">ObjectFile</a>
550+
</code>
551+
</div>
552+
<div class="height-container">
553+
<div class="pointer-container"></div>
554+
<section class="section">
555+
<div class="pointer"></div>
556+
<div class="abstract">
557+
<p>An in-memory representation of a platform object file.</p>
558+
559+
<a href="Classes/ObjectFile.html" class="slightly-smaller">See more</a>
560+
</div>
561+
<div class="declaration">
562+
<h4>Declaration</h4>
563+
<div class="language">
564+
<p class="aside-title">Swift</p>
565+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ObjectFile</span></code></pre>
566+
567+
</div>
568+
</div>
569+
</section>
570+
</div>
571+
</li>
572+
<li class="item">
573+
<div>
574+
<code>
575+
<a name="/s:C4LLVM15SectionSequence"></a>
576+
<a name="//apple_ref/swift/Class/SectionSequence" class="dashAnchor"></a>
577+
<a class="token" href="#/s:C4LLVM15SectionSequence">SectionSequence</a>
578+
</code>
579+
</div>
580+
<div class="height-container">
581+
<div class="pointer-container"></div>
582+
<section class="section">
583+
<div class="pointer"></div>
584+
<div class="abstract">
585+
<p>A sequence for iterating over the sections in an object file.</p>
586+
587+
<a href="Classes/SectionSequence.html" class="slightly-smaller">See more</a>
588+
</div>
589+
<div class="declaration">
590+
<h4>Declaration</h4>
591+
<div class="language">
592+
<p class="aside-title">Swift</p>
593+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SectionSequence</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
594+
595+
</div>
596+
</div>
597+
</section>
598+
</div>
599+
</li>
600+
<li class="item">
601+
<div>
602+
<code>
603+
<a name="/s:C4LLVM18RelocationSequence"></a>
604+
<a name="//apple_ref/swift/Class/RelocationSequence" class="dashAnchor"></a>
605+
<a class="token" href="#/s:C4LLVM18RelocationSequence">RelocationSequence</a>
606+
</code>
607+
</div>
608+
<div class="height-container">
609+
<div class="pointer-container"></div>
610+
<section class="section">
611+
<div class="pointer"></div>
612+
<div class="abstract">
613+
<p>A sequence for iterating over the relocations in an object file.</p>
614+
615+
<a href="Classes/RelocationSequence.html" class="slightly-smaller">See more</a>
616+
</div>
617+
<div class="declaration">
618+
<h4>Declaration</h4>
619+
<div class="language">
620+
<p class="aside-title">Swift</p>
621+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">RelocationSequence</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
622+
623+
</div>
624+
</div>
625+
</section>
626+
</div>
627+
</li>
628+
<li class="item">
629+
<div>
630+
<code>
631+
<a name="/s:C4LLVM14SymbolSequence"></a>
632+
<a name="//apple_ref/swift/Class/SymbolSequence" class="dashAnchor"></a>
633+
<a class="token" href="#/s:C4LLVM14SymbolSequence">SymbolSequence</a>
634+
</code>
635+
</div>
636+
<div class="height-container">
637+
<div class="pointer-container"></div>
638+
<section class="section">
639+
<div class="pointer"></div>
640+
<div class="abstract">
641+
<p>A sequence for iterating over the symbols in an object file.</p>
642+
643+
<a href="Classes/SymbolSequence.html" class="slightly-smaller">See more</a>
644+
</div>
645+
<div class="declaration">
646+
<h4>Declaration</h4>
647+
<div class="language">
648+
<p class="aside-title">Swift</p>
649+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">SymbolSequence</span><span class="p">:</span> <span class="kt">Sequence</span></code></pre>
650+
651+
</div>
652+
</div>
653+
</section>
654+
</div>
655+
</li>
656+
</ul>
657+
</div>
500658
<div class="task-group">
501659
<ul>
502660
<li class="item">
@@ -631,8 +789,8 @@ <h4>Declaration</h4>
631789
</section>
632790
</section>
633791
<section id="footer">
634-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-02-15)</p>
635-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
792+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-07)</p>
793+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
636794
</section>
637795
</article>
638796
</div>

‎docs/Classes/Context.html

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Context Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html"> Docs</a> (100% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (99% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -51,6 +51,18 @@
5151
<li class="nav-group-task">
5252
<a href="../Classes/Module.html">Module</a>
5353
</li>
54+
<li class="nav-group-task">
55+
<a href="../Classes/ObjectFile.html">ObjectFile</a>
56+
</li>
57+
<li class="nav-group-task">
58+
<a href="../Classes/RelocationSequence.html">RelocationSequence</a>
59+
</li>
60+
<li class="nav-group-task">
61+
<a href="../Classes/SectionSequence.html">SectionSequence</a>
62+
</li>
63+
<li class="nav-group-task">
64+
<a href="../Classes/SymbolSequence.html">SymbolSequence</a>
65+
</li>
5466
<li class="nav-group-task">
5567
<a href="../Classes/Target.html">Target</a>
5668
</li>
@@ -101,6 +113,9 @@
101113
<li class="nav-group-task">
102114
<a href="../Enums/JITError.html">JITError</a>
103115
</li>
116+
<li class="nav-group-task">
117+
<a href="../Enums/LandingPadClause.html">LandingPadClause</a>
118+
</li>
104119
<li class="nav-group-task">
105120
<a href="../Enums/Linkage.html">Linkage</a>
106121
</li>
@@ -113,6 +128,12 @@
113128
<li class="nav-group-task">
114129
<a href="../Enums/OpCode.html">OpCode</a>
115130
</li>
131+
<li class="nav-group-task">
132+
<a href="../Enums/OpCode/Binary.html">– Binary</a>
133+
</li>
134+
<li class="nav-group-task">
135+
<a href="../Enums/OpCode/Cast.html">– Cast</a>
136+
</li>
116137
<li class="nav-group-task">
117138
<a href="../Enums/OverflowBehavior.html">OverflowBehavior</a>
118139
</li>
@@ -125,6 +146,9 @@
125146
<li class="nav-group-task">
126147
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
127148
</li>
149+
<li class="nav-group-task">
150+
<a href="../Enums/StorageClass.html">StorageClass</a>
151+
</li>
128152
<li class="nav-group-task">
129153
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
130154
</li>
@@ -229,6 +253,9 @@
229253
<li class="nav-group-task">
230254
<a href="../Structs/BasicBlock/Address.html">– Address</a>
231255
</li>
256+
<li class="nav-group-task">
257+
<a href="../Structs/Call.html">Call</a>
258+
</li>
232259
<li class="nav-group-task">
233260
<a href="../Structs/Constant.html">Constant</a>
234261
</li>
@@ -244,6 +271,9 @@
244271
<li class="nav-group-task">
245272
<a href="../Structs/IntType.html">IntType</a>
246273
</li>
274+
<li class="nav-group-task">
275+
<a href="../Structs/Invoke.html">Invoke</a>
276+
</li>
247277
<li class="nav-group-task">
248278
<a href="../Structs/LabelType.html">LabelType</a>
249279
</li>
@@ -259,12 +289,24 @@
259289
<li class="nav-group-task">
260290
<a href="../Structs/PointerType.html">PointerType</a>
261291
</li>
292+
<li class="nav-group-task">
293+
<a href="../Structs/Relocation.html">Relocation</a>
294+
</li>
295+
<li class="nav-group-task">
296+
<a href="../Structs/Section.html">Section</a>
297+
</li>
262298
<li class="nav-group-task">
263299
<a href="../Structs/StructType.html">StructType</a>
264300
</li>
265301
<li class="nav-group-task">
266302
<a href="../Structs/Switch.html">Switch</a>
267303
</li>
304+
<li class="nav-group-task">
305+
<a href="../Structs/Symbol.html">Symbol</a>
306+
</li>
307+
<li class="nav-group-task">
308+
<a href="../Structs/TerminatorInstruction.html">TerminatorInstruction</a>
309+
</li>
268310
<li class="nav-group-task">
269311
<a href="../Structs/TokenType.html">TokenType</a>
270312
</li>
@@ -359,8 +401,8 @@ <h4>Declaration</h4>
359401
</section>
360402
</section>
361403
<section id="footer">
362-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-02-15)</p>
363-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
404+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-07)</p>
405+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
364406
</section>
365407
</article>
366408
</div>

0 commit comments

Comments
 (0)