Skip to content

Commit 8d7424c

Browse files
CodaFiCodaFi
authored
Merge pull request #124 from CodaFi/whats-up-doc
Update Docs
2 parents 9ce5f07 + 03b4918 commit 8d7424c

File tree

208 files changed

+32160
-14815
lines changed

Some content is hidden

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

208 files changed

+32160
-14815
lines changed

‎Sources/LLVM/Constant.swift

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1087,6 +1087,13 @@ extension Constant where Repr == Floating {
10871087
return lhs.remainder(rhs)
10881088
}
10891089

1090+
/// A constant equality comparison between two values.
1091+
///
1092+
/// - parameter lhs: The first value to compare.
1093+
/// - parameter rhs: The second value to compare.
1094+
///
1095+
/// - returns: A constant integral value (i1) representing the result of the
1096+
/// comparision of the given operands.
10901097
public static func ==(lhs: Constant, rhs: Constant) -> Constant<Signed> {
10911098
return Constant.equals(lhs, rhs)
10921099
}

‎Sources/LLVM/FloatType.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public struct FloatType: IRType {
2222
self.context = context
2323
}
2424

25+
/// Enumerates the bitwidth and kind of supported floating point types.
2526
public enum Kind {
2627
/// 16-bit floating point value
2728
case half

‎Sources/LLVM/IntrinsicsDef.swift

Lines changed: 1656 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Classes.html

Lines changed: 72 additions & 63 deletions
Large diffs are not rendered by default.

‎docs/Classes/Context.html

Lines changed: 65 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
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">LLVM Docs</a> (100% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
2121
<p id="breadcrumbs">
22-
<a href="../index.html"> Reference</a>
22+
<a href="../index.html">LLVM Reference</a>
2323
<img id="carat" src="../img/carat.png" />
2424
Context Class Reference
2525
</p>
@@ -75,7 +75,7 @@
7575
</ul>
7676
</li>
7777
<li class="nav-group-name">
78-
<a href="../Enums.html">Enums</a>
78+
<a href="../Enums.html">Enumerations</a>
7979
<ul class="nav-group-tasks">
8080
<li class="nav-group-task">
8181
<a href="../Enums/AtomicOrdering.html">AtomicOrdering</a>
@@ -99,10 +99,7 @@
9999
<a href="../Enums/CodegenFileType.html">CodegenFileType</a>
100100
</li>
101101
<li class="nav-group-task">
102-
<a href="../Enums/FloatType.html">FloatType</a>
103-
</li>
104-
<li class="nav-group-task">
105-
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
102+
<a href="../Enums.html#/s:4LLVM8FloatingO">Floating</a>
106103
</li>
107104
<li class="nav-group-task">
108105
<a href="../Enums/FunctionPass.html">FunctionPass</a>
@@ -144,19 +141,28 @@
144141
<a href="../Enums/RelocMode.html">RelocMode</a>
145142
</li>
146143
<li class="nav-group-task">
147-
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
144+
<a href="../Enums.html#/s:4LLVM6SignedO">Signed</a>
148145
</li>
149146
<li class="nav-group-task">
150147
<a href="../Enums/StorageClass.html">StorageClass</a>
151148
</li>
149+
<li class="nav-group-task">
150+
<a href="../Enums.html#/s:4LLVM6StructO">Struct</a>
151+
</li>
152152
<li class="nav-group-task">
153153
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
154154
</li>
155155
<li class="nav-group-task">
156156
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
157157
</li>
158158
<li class="nav-group-task">
159-
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
159+
<a href="../Enums/UnnamedAddressKind.html">UnnamedAddressKind</a>
160+
</li>
161+
<li class="nav-group-task">
162+
<a href="../Enums.html#/s:4LLVM8UnsignedO">Unsigned</a>
163+
</li>
164+
<li class="nav-group-task">
165+
<a href="../Enums.html#/s:4LLVM6VectorO">Vector</a>
160166
</li>
161167
<li class="nav-group-task">
162168
<a href="../Enums/Visibility.html">Visibility</a>
@@ -211,21 +217,15 @@
211217
<a href="../Functions.html">Functions</a>
212218
<ul class="nav-group-tasks">
213219
<li class="nav-group-task">
214-
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
215-
</li>
216-
<li class="nav-group-task">
217-
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
218-
</li>
219-
<li class="nav-group-task">
220-
<a href="../Functions.html#/s:F4LLVM14initializeLLVMFT_T_">initializeLLVM()</a>
220+
<a href="../Functions.html#/s:4LLVM010initializeA0yyF">initializeLLVM()</a>
221221
</li>
222222
</ul>
223223
</li>
224224
<li class="nav-group-name">
225225
<a href="../Protocols.html">Protocols</a>
226226
<ul class="nav-group-tasks">
227227
<li class="nav-group-task">
228-
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
228+
<a href="../Protocols.html#/s:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
229229
</li>
230230
<li class="nav-group-task">
231231
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
@@ -237,12 +237,15 @@
237237
<a href="../Protocols/IRValue.html">IRValue</a>
238238
</li>
239239
<li class="nav-group-task">
240-
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
240+
<a href="../Protocols.html#/s:4LLVM30IntegralConstantRepresentationP">IntegralConstantRepresentation</a>
241+
</li>
242+
<li class="nav-group-task">
243+
<a href="../Protocols.html#/s:4LLVM31NumericalConstantRepresentationP">NumericalConstantRepresentation</a>
241244
</li>
242245
</ul>
243246
</li>
244247
<li class="nav-group-name">
245-
<a href="../Structs.html">Structs</a>
248+
<a href="../Structs.html">Structures</a>
246249
<ul class="nav-group-tasks">
247250
<li class="nav-group-task">
248251
<a href="../Structs/Alias.html">Alias</a>
@@ -262,6 +265,12 @@
262265
<li class="nav-group-task">
263266
<a href="../Structs/Constant.html">Constant</a>
264267
</li>
268+
<li class="nav-group-task">
269+
<a href="../Structs/FloatType.html">FloatType</a>
270+
</li>
271+
<li class="nav-group-task">
272+
<a href="../Structs/FloatType/Kind.html">– Kind</a>
273+
</li>
265274
<li class="nav-group-task">
266275
<a href="../Structs/FunctionType.html">FunctionType</a>
267276
</li>
@@ -335,7 +344,7 @@
335344
<h1>Context</h1>
336345
<div class="declaration">
337346
<div class="language">
338-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Context</span></code></pre>
347+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Context</span></code></pre>
339348

340349
</div>
341350
</div>
@@ -348,9 +357,9 @@ <h1>Context</h1>
348357
<li class="item">
349358
<div>
350359
<code>
351-
<a name="/s:ZvC4LLVM7Context6globalS0_"></a>
360+
<a name="/s:4LLVM7ContextC6globalACvZ"></a>
352361
<a name="//apple_ref/swift/Variable/global" class="dashAnchor"></a>
353-
<a class="token" href="#/s:ZvC4LLVM7Context6globalS0_">global</a>
362+
<a class="token" href="#/s:4LLVM7ContextC6globalACvZ">global</a>
354363
</code>
355364
</div>
356365
<div class="height-container">
@@ -365,7 +374,34 @@ <h1>Context</h1>
365374
<h4>Declaration</h4>
366375
<div class="language">
367376
<p class="aside-title">Swift</p>
368-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">global</span> <span class="o">=</span> <span class="kt">Context</span><span class="p">(</span><span class="nv">llvm</span><span class="p">:</span> <span class="kt">LLVMGetGlobalContext</span><span class="p">()</span><span class="o">!</span><span class="p">)</span></code></pre>
377+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">global</span> <span class="o">=</span> <span class="kt">Context</span><span class="p">(</span><span class="nv">llvm</span><span class="p">:</span> <span class="kt">LLVMGetGlobalContext</span><span class="p">()</span><span class="o">!</span><span class="p">)</span></code></pre>
378+
379+
</div>
380+
</div>
381+
</section>
382+
</div>
383+
</li>
384+
<li class="item">
385+
<div>
386+
<code>
387+
<a name="/s:4LLVM7ContextCACycfc"></a>
388+
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
389+
<a class="token" href="#/s:4LLVM7ContextCACycfc">init()</a>
390+
</code>
391+
</div>
392+
<div class="height-container">
393+
<div class="pointer-container"></div>
394+
<section class="section">
395+
<div class="pointer"></div>
396+
<div class="abstract">
397+
<p>Creates a <code>Context</code> object using <code>LLVMContextCreate</code></p>
398+
399+
</div>
400+
<div class="declaration">
401+
<h4>Declaration</h4>
402+
<div class="language">
403+
<p class="aside-title">Swift</p>
404+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>
369405

370406
</div>
371407
</div>
@@ -375,9 +411,9 @@ <h4>Declaration</h4>
375411
<li class="item">
376412
<div>
377413
<code>
378-
<a name="/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_"></a>
379-
<a name="//apple_ref/swift/Method/init(llvm:)" class="dashAnchor"></a>
380-
<a class="token" href="#/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_">init(llvm:)</a>
414+
<a name="/s:4LLVM7ContextCACs13OpaquePointerV4llvm_Sb04ownsB0tcfc"></a>
415+
<a name="//apple_ref/swift/Method/init(llvm:ownsContext:)" class="dashAnchor"></a>
416+
<a class="token" href="#/s:4LLVM7ContextCACs13OpaquePointerV4llvm_Sb04ownsB0tcfc">init(llvm:ownsContext:)</a>
381417
</code>
382418
</div>
383419
<div class="height-container">
@@ -392,7 +428,7 @@ <h4>Declaration</h4>
392428
<h4>Declaration</h4>
393429
<div class="language">
394430
<p class="aside-title">Swift</p>
395-
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">llvm</span><span class="p">:</span> <span class="kt">LLVMContextRef</span><span class="p">)</span></code></pre>
431+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">llvm</span><span class="p">:</span> <span class="kt">LLVMContextRef</span><span class="p">,</span> <span class="nv">ownsContext</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
396432

397433
</div>
398434
</div>
@@ -404,8 +440,8 @@ <h4>Declaration</h4>
404440
</section>
405441
</section>
406442
<section id="footer">
407-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-30)</p>
408-
<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>
443+
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-18)</p>
444+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
409445
</section>
410446
</article>
411447
</div>

0 commit comments

Comments
 (0)