Skip to content

Update Docs #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2018
Merged

Update Docs #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Sources/LLVM/Constant.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1087,6 +1087,13 @@ extension Constant where Repr == Floating {
return lhs.remainder(rhs)
}

/// A constant equality comparison between two values.
///
/// - parameter lhs: The first value to compare.
/// - parameter rhs: The second value to compare.
///
/// - returns: A constant integral value (i1) representing the result of the
/// comparision of the given operands.
public static func ==(lhs: Constant, rhs: Constant) -> Constant<Signed> {
return Constant.equals(lhs, rhs)
}
Expand Down
1 change: 1 addition & 0 deletions Sources/LLVM/FloatType.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ public struct FloatType: IRType {
self.context = context
}

/// Enumerates the bitwidth and kind of supported floating point types.
public enum Kind {
/// 16-bit floating point value
case half
Expand Down
1,656 changes: 1,656 additions & 0 deletions Sources/LLVM/IntrinsicsDef.swift
View file
Open in desktop

Large diffs are not rendered by default.

135 changes: 72 additions & 63 deletions docs/Classes.html
View file
Open in desktop

Large diffs are not rendered by default.

94 changes: 65 additions & 29 deletions docs/Classes/Context.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@
<a title="Context Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
<p><a href="../index.html">LLVM Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<a href="../index.html">LLVM Reference</a>
<img id="carat" src="../img/carat.png" />
Context Class Reference
</p>
Expand Down Expand Up @@ -75,7 +75,7 @@
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/AtomicOrdering.html">AtomicOrdering</a>
Expand All @@ -99,10 +99,7 @@
<a href="../Enums/CodegenFileType.html">CodegenFileType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
<a href="../Enums.html#/s:4LLVM8FloatingO">Floating</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FunctionPass.html">FunctionPass</a>
Expand Down Expand Up @@ -144,19 +141,28 @@
<a href="../Enums/RelocMode.html">RelocMode</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
<a href="../Enums.html#/s:4LLVM6SignedO">Signed</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StorageClass.html">StorageClass</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:4LLVM6StructO">Struct</a>
</li>
<li class="nav-group-task">
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
<a href="../Enums/UnnamedAddressKind.html">UnnamedAddressKind</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:4LLVM8UnsignedO">Unsigned</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:4LLVM6VectorO">Vector</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Visibility.html">Visibility</a>
Expand Down Expand Up @@ -211,21 +217,15 @@
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVM14initializeLLVMFT_T_">initializeLLVM()</a>
<a href="../Functions.html#/s:4LLVM010initializeA0yyF">initializeLLVM()</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
<a href="../Protocols.html#/s:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
Expand All @@ -237,12 +237,15 @@
<a href="../Protocols/IRValue.html">IRValue</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
<a href="../Protocols.html#/s:4LLVM30IntegralConstantRepresentationP">IntegralConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:4LLVM31NumericalConstantRepresentationP">NumericalConstantRepresentation</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/Alias.html">Alias</a>
Expand All @@ -262,6 +265,12 @@
<li class="nav-group-task">
<a href="../Structs/Constant.html">Constant</a>
</li>
<li class="nav-group-task">
<a href="../Structs/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="../Structs/FloatType/Kind.html">– Kind</a>
</li>
<li class="nav-group-task">
<a href="../Structs/FunctionType.html">FunctionType</a>
</li>
Expand Down Expand Up @@ -335,7 +344,7 @@
<h1>Context</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Context</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Context</span></code></pre>

</div>
</div>
Expand All @@ -348,9 +357,9 @@ <h1>Context</h1>
<li class="item">
<div>
<code>
<a name="/s:ZvC4LLVM7Context6globalS0_"></a>
<a name="/s:4LLVM7ContextC6globalACvZ"></a>
<a name="//apple_ref/swift/Variable/global" class="dashAnchor"></a>
<a class="token" href="#/s:ZvC4LLVM7Context6globalS0_">global</a>
<a class="token" href="#/s:4LLVM7ContextC6globalACvZ">global</a>
</code>
</div>
<div class="height-container">
Expand All @@ -365,7 +374,34 @@ <h1>Context</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<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>
<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>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4LLVM7ContextCACycfc"></a>
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM7ContextCACycfc">init()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a <code>Context</code> object using <code>LLVMContextCreate</code></p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">()</span></code></pre>

</div>
</div>
Expand All @@ -375,9 +411,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_"></a>
<a name="//apple_ref/swift/Method/init(llvm:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_">init(llvm:)</a>
<a name="/s:4LLVM7ContextCACs13OpaquePointerV4llvm_Sb04ownsB0tcfc"></a>
<a name="//apple_ref/swift/Method/init(llvm:ownsContext:)" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM7ContextCACs13OpaquePointerV4llvm_Sb04ownsB0tcfc">init(llvm:ownsContext:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -392,7 +428,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<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>
<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>

</div>
</div>
Expand All @@ -404,8 +440,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-30)</p>
<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>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-02-18)</p>
<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>
</section>
</article>
</div>
Expand Down
Loading