Skip to content

100% DOCUMENTATION #97

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
Aug 31, 2017
Merged

100% DOCUMENTATION #97

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
12 changes: 12 additions & 0 deletions Package.pins
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"autoPin": true,
"pins": [
{
"package": "cllvm",
"reason": null,
"repositoryURL": "https://github.com/trill-lang/cllvm.git",
"version": "0.0.3"
}
],
"version": 1
}
79 changes: 41 additions & 38 deletions docs/Classes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (99% documented)</p>
<p><a href="index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -101,7 +101,7 @@
<a href="Enums/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="Enums.html#/s:4LLVM8FloatingO">Floating</a>
<a href="Enums.html#/s:O4LLVM8Floating">Floating</a>
</li>
<li class="nav-group-task">
<a href="Enums/FunctionPass.html">FunctionPass</a>
Expand Down Expand Up @@ -143,7 +143,7 @@
<a href="Enums/RelocMode.html">RelocMode</a>
</li>
<li class="nav-group-task">
<a href="Enums.html#/s:4LLVM6SignedO">Signed</a>
<a href="Enums.html#/s:O4LLVM6Signed">Signed</a>
</li>
<li class="nav-group-task">
<a href="Enums/StorageClass.html">StorageClass</a>
Expand All @@ -155,7 +155,7 @@
<a href="Enums/ThreadLocalModel.html">ThreadLocalModel</a>
</li>
<li class="nav-group-task">
<a href="Enums.html#/s:4LLVM8UnsignedO">Unsigned</a>
<a href="Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
</li>
<li class="nav-group-task">
<a href="Enums/Visibility.html">Visibility</a>
Expand Down Expand Up @@ -210,18 +210,21 @@
<a href="Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Functions.html#/s:4LLVM1sopAA8ConstantVyAA6SignedOGAGF">-(_:)</a>
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:4LLVM1sopAA8ConstantVyAA8FloatingOGAGF">-(_:)</a>
<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>
</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:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
<a href="Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="Protocols/IRGlobal.html">IRGlobal</a>
Expand All @@ -233,7 +236,7 @@
<a href="Protocols/IRValue.html">IRValue</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/s:4LLVM30IntegralConstantRepresentationP">IntegralConstantRepresentation</a>
<a href="Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -338,9 +341,9 @@ <h1>Classes</h1>
<li class="item">
<div>
<code>
<a name="/s:4LLVM8FunctionC"></a>
<a name="/s:C4LLVM8Function"></a>
<a name="//apple_ref/swift/Class/Function" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM8FunctionC">Function</a>
<a class="token" href="#/s:C4LLVM8Function">Function</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -372,9 +375,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM6ModuleC"></a>
<a name="/s:C4LLVM6Module"></a>
<a name="//apple_ref/swift/Class/Module" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM6ModuleC">Module</a>
<a class="token" href="#/s:C4LLVM6Module">Module</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -402,9 +405,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM7ContextC"></a>
<a name="/s:C4LLVM7Context"></a>
<a name="//apple_ref/swift/Class/Context" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM7ContextC">Context</a>
<a class="token" href="#/s:C4LLVM7Context">Context</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -434,9 +437,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM9IRBuilderC"></a>
<a name="/s:C4LLVM9IRBuilder"></a>
<a name="//apple_ref/swift/Class/IRBuilder" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM9IRBuilderC">IRBuilder</a>
<a class="token" href="#/s:C4LLVM9IRBuilder">IRBuilder</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -468,9 +471,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM3JITC"></a>
<a name="/s:C4LLVM3JIT"></a>
<a name="//apple_ref/swift/Class/JIT" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM3JITC">JIT</a>
<a class="token" href="#/s:C4LLVM3JIT">JIT</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -503,9 +506,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM12MemoryBufferC"></a>
<a name="/s:C4LLVM12MemoryBuffer"></a>
<a name="//apple_ref/swift/Class/MemoryBuffer" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM12MemoryBufferC">MemoryBuffer</a>
<a class="token" href="#/s:C4LLVM12MemoryBuffer">MemoryBuffer</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -544,17 +547,17 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM10ObjectFileC"></a>
<a name="/s:C4LLVM10ObjectFile"></a>
<a name="//apple_ref/swift/Class/ObjectFile" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM10ObjectFileC">ObjectFile</a>
<a class="token" href="#/s:C4LLVM10ObjectFile">ObjectFile</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An in-memory representation of a platform object file.</p>
<p>An in-memory representation of a format-independent object file.</p>

<a href="Classes/ObjectFile.html" class="slightly-smaller">See more</a>
</div>
Expand All @@ -572,9 +575,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM15SectionSequenceC"></a>
<a name="/s:C4LLVM15SectionSequence"></a>
<a name="//apple_ref/swift/Class/SectionSequence" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM15SectionSequenceC">SectionSequence</a>
<a class="token" href="#/s:C4LLVM15SectionSequence">SectionSequence</a>
</code>
</div>
<div class="height-container">
Expand All @@ -600,9 +603,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM18RelocationSequenceC"></a>
<a name="/s:C4LLVM18RelocationSequence"></a>
<a name="//apple_ref/swift/Class/RelocationSequence" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM18RelocationSequenceC">RelocationSequence</a>
<a class="token" href="#/s:C4LLVM18RelocationSequence">RelocationSequence</a>
</code>
</div>
<div class="height-container">
Expand All @@ -628,9 +631,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM14SymbolSequenceC"></a>
<a name="/s:C4LLVM14SymbolSequence"></a>
<a name="//apple_ref/swift/Class/SymbolSequence" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM14SymbolSequenceC">SymbolSequence</a>
<a class="token" href="#/s:C4LLVM14SymbolSequence">SymbolSequence</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -660,9 +663,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM19FunctionPassManagerC"></a>
<a name="/s:C4LLVM19FunctionPassManager"></a>
<a name="//apple_ref/swift/Class/FunctionPassManager" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM19FunctionPassManagerC">FunctionPassManager</a>
<a class="token" href="#/s:C4LLVM19FunctionPassManager">FunctionPassManager</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -694,9 +697,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM10TargetDataC"></a>
<a name="/s:C4LLVM10TargetData"></a>
<a name="//apple_ref/swift/Class/TargetData" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM10TargetDataC">TargetData</a>
<a class="token" href="#/s:C4LLVM10TargetData">TargetData</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -728,9 +731,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM6TargetC"></a>
<a name="/s:C4LLVM6Target"></a>
<a name="//apple_ref/swift/Class/Target" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM6TargetC">Target</a>
<a class="token" href="#/s:C4LLVM6Target">Target</a>
</code>
</div>
<div class="height-container">
Expand All @@ -757,9 +760,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM13TargetMachineC"></a>
<a name="/s:C4LLVM13TargetMachine"></a>
<a name="//apple_ref/swift/Class/TargetMachine" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM13TargetMachineC">TargetMachine</a>
<a class="token" href="#/s:C4LLVM13TargetMachine">TargetMachine</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -789,7 +792,7 @@ <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-19)</p>
<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>
</section>
</article>
Expand Down
29 changes: 16 additions & 13 deletions docs/Classes/Context.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Context Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (99% documented)</p>
<p><a href="../index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
Expand Down Expand Up @@ -102,7 +102,7 @@
<a href="../Enums/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:4LLVM8FloatingO">Floating</a>
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FunctionPass.html">FunctionPass</a>
Expand Down Expand Up @@ -144,7 +144,7 @@
<a href="../Enums/RelocMode.html">RelocMode</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:4LLVM6SignedO">Signed</a>
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
</li>
<li class="nav-group-task">
<a href="../Enums/StorageClass.html">StorageClass</a>
Expand All @@ -156,7 +156,7 @@
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:4LLVM8UnsignedO">Unsigned</a>
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Visibility.html">Visibility</a>
Expand Down Expand Up @@ -211,18 +211,21 @@
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/s:4LLVM1sopAA8ConstantVyAA6SignedOGAGF">-(_:)</a>
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:4LLVM1sopAA8ConstantVyAA8FloatingOGAGF">-(_:)</a>
<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>
</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:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
Expand All @@ -234,7 +237,7 @@
<a href="../Protocols/IRValue.html">IRValue</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:4LLVM30IntegralConstantRepresentationP">IntegralConstantRepresentation</a>
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -345,9 +348,9 @@ <h1>Context</h1>
<li class="item">
<div>
<code>
<a name="/s:4LLVM7ContextC6globalACvZ"></a>
<a name="/s:ZvC4LLVM7Context6globalS0_"></a>
<a name="//apple_ref/swift/Variable/global" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM7ContextC6globalACvZ">global</a>
<a class="token" href="#/s:ZvC4LLVM7Context6globalS0_">global</a>
</code>
</div>
<div class="height-container">
Expand All @@ -372,9 +375,9 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:4LLVM7ContextCACs13OpaquePointerV4llvm_tcfc"></a>
<a name="/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_"></a>
<a name="//apple_ref/swift/Method/init(llvm:)" class="dashAnchor"></a>
<a class="token" href="#/s:4LLVM7ContextCACs13OpaquePointerV4llvm_tcfc">init(llvm:)</a>
<a class="token" href="#/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_">init(llvm:)</a>
</code>
</div>
<div class="height-container">
Expand All @@ -401,7 +404,7 @@ <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-19)</p>
<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>
</section>
</article>
Expand Down
Loading