Skip to content

Commit 767cc2f

Browse files
CodaFiCodaFi
authored
Merge pull request #55 from CodaFi/doctwork
Update documentation
2 parents 9b55780 + bec2db8 commit 767cc2f

File tree

150 files changed

+11182
-194
lines changed

Some content is hidden

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

150 files changed

+11182
-194
lines changed

‎docs/Classes.html‎

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@
7373
<li class="nav-group-task">
7474
<a href="Enums/ByteOrder.html">ByteOrder</a>
7575
</li>
76+
<li class="nav-group-task">
77+
<a href="Enums/CallingConvention.html">CallingConvention</a>
78+
</li>
7679
<li class="nav-group-task">
7780
<a href="Enums/CodeGenOptLevel.html">CodeGenOptLevel</a>
7881
</li>
@@ -85,6 +88,9 @@
8588
<li class="nav-group-task">
8689
<a href="Enums/FloatType.html">FloatType</a>
8790
</li>
91+
<li class="nav-group-task">
92+
<a href="Enums.html#/s:O4LLVM8Floating">Floating</a>
93+
</li>
8894
<li class="nav-group-task">
8995
<a href="Enums/FunctionPass.html">FunctionPass</a>
9096
</li>
@@ -115,9 +121,15 @@
115121
<li class="nav-group-task">
116122
<a href="Enums/RelocMode.html">RelocMode</a>
117123
</li>
124+
<li class="nav-group-task">
125+
<a href="Enums.html#/s:O4LLVM6Signed">Signed</a>
126+
</li>
118127
<li class="nav-group-task">
119128
<a href="Enums/TargetMachineError.html">TargetMachineError</a>
120129
</li>
130+
<li class="nav-group-task">
131+
<a href="Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
132+
</li>
121133
<li class="nav-group-task">
122134
<a href="Enums/Visibility.html">Visibility</a>
123135
</li>
@@ -167,9 +179,23 @@
167179
</li>
168180
</ul>
169181
</li>
182+
<li class="nav-group-name">
183+
<a href="Functions.html">Functions</a>
184+
<ul class="nav-group-tasks">
185+
<li class="nav-group-task">
186+
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
187+
</li>
188+
<li class="nav-group-task">
189+
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
190+
</li>
191+
</ul>
192+
</li>
170193
<li class="nav-group-name">
171194
<a href="Protocols.html">Protocols</a>
172195
<ul class="nav-group-tasks">
196+
<li class="nav-group-task">
197+
<a href="Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
198+
</li>
173199
<li class="nav-group-task">
174200
<a href="Protocols/IRGlobal.html">IRGlobal</a>
175201
</li>
@@ -179,6 +205,9 @@
179205
<li class="nav-group-task">
180206
<a href="Protocols/IRValue.html">IRValue</a>
181207
</li>
208+
<li class="nav-group-task">
209+
<a href="Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
210+
</li>
182211
</ul>
183212
</li>
184213
<li class="nav-group-name">
@@ -193,6 +222,9 @@
193222
<li class="nav-group-task">
194223
<a href="Structs/BasicBlock.html">BasicBlock</a>
195224
</li>
225+
<li class="nav-group-task">
226+
<a href="Structs/Constant.html">Constant</a>
227+
</li>
196228
<li class="nav-group-task">
197229
<a href="Structs/FunctionType.html">FunctionType</a>
198230
</li>
@@ -437,11 +469,11 @@ <h4>Declaration</h4>
437469
provides simple methods for reading files and standard input into a memory
438470
buffer. In addition to basic access to the characters in the file, this
439471
interface guarantees you can read one character past the end of the file,
440-
and that this character will read as &rsquo;\0&rsquo;.</p>
472+
and that this character will read as &lsquo;\0&rsquo;.</p>
441473

442-
<p>The &rsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
474+
<p>The &lsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
443475
be more efficient for clients which are reading all the data to stop
444-
reading when they encounter a &rsquo;\0&rsquo; than to continually check the file
476+
reading when they encounter a &lsquo;\0&rsquo; than to continually check the file
445477
position to see if it has reached the end of the file.</p>
446478

447479
<a href="Classes/MemoryBuffer.html" class="slightly-smaller">See more</a>
@@ -593,7 +625,7 @@ <h4>Declaration</h4>
593625
</section>
594626
</section>
595627
<section id="footer">
596-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-15)</p>
628+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
597629
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
598630
</section>
599631
</article>

‎docs/Classes/Context.html‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@
7474
<li class="nav-group-task">
7575
<a href="../Enums/ByteOrder.html">ByteOrder</a>
7676
</li>
77+
<li class="nav-group-task">
78+
<a href="../Enums/CallingConvention.html">CallingConvention</a>
79+
</li>
7780
<li class="nav-group-task">
7881
<a href="../Enums/CodeGenOptLevel.html">CodeGenOptLevel</a>
7982
</li>
@@ -86,6 +89,9 @@
8689
<li class="nav-group-task">
8790
<a href="../Enums/FloatType.html">FloatType</a>
8891
</li>
92+
<li class="nav-group-task">
93+
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
94+
</li>
8995
<li class="nav-group-task">
9096
<a href="../Enums/FunctionPass.html">FunctionPass</a>
9197
</li>
@@ -116,9 +122,15 @@
116122
<li class="nav-group-task">
117123
<a href="../Enums/RelocMode.html">RelocMode</a>
118124
</li>
125+
<li class="nav-group-task">
126+
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
127+
</li>
119128
<li class="nav-group-task">
120129
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
121130
</li>
131+
<li class="nav-group-task">
132+
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
133+
</li>
122134
<li class="nav-group-task">
123135
<a href="../Enums/Visibility.html">Visibility</a>
124136
</li>
@@ -168,9 +180,23 @@
168180
</li>
169181
</ul>
170182
</li>
183+
<li class="nav-group-name">
184+
<a href="../Functions.html">Functions</a>
185+
<ul class="nav-group-tasks">
186+
<li class="nav-group-task">
187+
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
188+
</li>
189+
<li class="nav-group-task">
190+
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
191+
</li>
192+
</ul>
193+
</li>
171194
<li class="nav-group-name">
172195
<a href="../Protocols.html">Protocols</a>
173196
<ul class="nav-group-tasks">
197+
<li class="nav-group-task">
198+
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
199+
</li>
174200
<li class="nav-group-task">
175201
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
176202
</li>
@@ -180,6 +206,9 @@
180206
<li class="nav-group-task">
181207
<a href="../Protocols/IRValue.html">IRValue</a>
182208
</li>
209+
<li class="nav-group-task">
210+
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
211+
</li>
183212
</ul>
184213
</li>
185214
<li class="nav-group-name">
@@ -194,6 +223,9 @@
194223
<li class="nav-group-task">
195224
<a href="../Structs/BasicBlock.html">BasicBlock</a>
196225
</li>
226+
<li class="nav-group-task">
227+
<a href="../Structs/Constant.html">Constant</a>
228+
</li>
197229
<li class="nav-group-task">
198230
<a href="../Structs/FunctionType.html">FunctionType</a>
199231
</li>
@@ -321,7 +353,7 @@ <h4>Declaration</h4>
321353
</section>
322354
</section>
323355
<section id="footer">
324-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-15)</p>
356+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
325357
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
326358
</section>
327359
</article>

‎docs/Classes/Function.html‎

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@
7474
<li class="nav-group-task">
7575
<a href="../Enums/ByteOrder.html">ByteOrder</a>
7676
</li>
77+
<li class="nav-group-task">
78+
<a href="../Enums/CallingConvention.html">CallingConvention</a>
79+
</li>
7780
<li class="nav-group-task">
7881
<a href="../Enums/CodeGenOptLevel.html">CodeGenOptLevel</a>
7982
</li>
@@ -86,6 +89,9 @@
8689
<li class="nav-group-task">
8790
<a href="../Enums/FloatType.html">FloatType</a>
8891
</li>
92+
<li class="nav-group-task">
93+
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
94+
</li>
8995
<li class="nav-group-task">
9096
<a href="../Enums/FunctionPass.html">FunctionPass</a>
9197
</li>
@@ -116,9 +122,15 @@
116122
<li class="nav-group-task">
117123
<a href="../Enums/RelocMode.html">RelocMode</a>
118124
</li>
125+
<li class="nav-group-task">
126+
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
127+
</li>
119128
<li class="nav-group-task">
120129
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
121130
</li>
131+
<li class="nav-group-task">
132+
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
133+
</li>
122134
<li class="nav-group-task">
123135
<a href="../Enums/Visibility.html">Visibility</a>
124136
</li>
@@ -168,9 +180,23 @@
168180
</li>
169181
</ul>
170182
</li>
183+
<li class="nav-group-name">
184+
<a href="../Functions.html">Functions</a>
185+
<ul class="nav-group-tasks">
186+
<li class="nav-group-task">
187+
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
188+
</li>
189+
<li class="nav-group-task">
190+
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
191+
</li>
192+
</ul>
193+
</li>
171194
<li class="nav-group-name">
172195
<a href="../Protocols.html">Protocols</a>
173196
<ul class="nav-group-tasks">
197+
<li class="nav-group-task">
198+
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
199+
</li>
174200
<li class="nav-group-task">
175201
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
176202
</li>
@@ -180,6 +206,9 @@
180206
<li class="nav-group-task">
181207
<a href="../Protocols/IRValue.html">IRValue</a>
182208
</li>
209+
<li class="nav-group-task">
210+
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
211+
</li>
183212
</ul>
184213
</li>
185214
<li class="nav-group-name">
@@ -194,6 +223,9 @@
194223
<li class="nav-group-task">
195224
<a href="../Structs/BasicBlock.html">BasicBlock</a>
196225
</li>
226+
<li class="nav-group-task">
227+
<a href="../Structs/Constant.html">Constant</a>
228+
</li>
197229
<li class="nav-group-task">
198230
<a href="../Structs/FunctionType.html">FunctionType</a>
199231
</li>
@@ -264,6 +296,33 @@ <h1>Function</h1>
264296
<section class="section task-group-section">
265297
<div class="task-group">
266298
<ul>
299+
<li class="item">
300+
<div>
301+
<code>
302+
<a name="/s:vC4LLVM8Function17callingConventionOS_17CallingConvention"></a>
303+
<a name="//apple_ref/swift/Property/callingConvention" class="dashAnchor"></a>
304+
<a class="token" href="#/s:vC4LLVM8Function17callingConventionOS_17CallingConvention">callingConvention</a>
305+
</code>
306+
</div>
307+
<div class="height-container">
308+
<div class="pointer-container"></div>
309+
<section class="section">
310+
<div class="pointer"></div>
311+
<div class="abstract">
312+
<p>Accesses the calling convention for this function.</p>
313+
314+
</div>
315+
<div class="declaration">
316+
<h4>Declaration</h4>
317+
<div class="language">
318+
<p class="aside-title">Swift</p>
319+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">callingConvention</span><span class="p">:</span> <span class="kt"><a href="../Enums/CallingConvention.html">CallingConvention</a></span></code></pre>
320+
321+
</div>
322+
</div>
323+
</section>
324+
</div>
325+
</li>
267326
<li class="item">
268327
<div>
269328
<code>
@@ -693,7 +752,7 @@ <h4>Declaration</h4>
693752
</section>
694753
</section>
695754
<section id="footer">
696-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-15)</p>
755+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
697756
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
698757
</section>
699758
</article>

0 commit comments

Comments
 (0)