Skip to content

Commit fb715ee

Browse files
CodaFiCodaFi
authored
Merge pull request #97 from CodaFi/extend-docing-coils
100% DOCUMENTATION
2 parents 394cf67 + 73cd331 commit fb715ee

File tree

189 files changed

+5805
-5111
lines changed

Some content is hidden

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

189 files changed

+5805
-5111
lines changed

‎Package.pins

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"autoPin": true,
3+
"pins": [
4+
{
5+
"package": "cllvm",
6+
"reason": null,
7+
"repositoryURL": "https://github.com/trill-lang/cllvm.git",
8+
"version": "0.0.3"
9+
}
10+
],
11+
"version": 1
12+
}

‎docs/Classes.html

Lines changed: 41 additions & 38 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> (99% documented)</p>
16+
<p><a href="index.html"> Docs</a> (100% documented)</p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
@@ -101,7 +101,7 @@
101101
<a href="Enums/FloatType.html">FloatType</a>
102102
</li>
103103
<li class="nav-group-task">
104-
<a href="Enums.html#/s:4LLVM8FloatingO">Floating</a>
104+
<a href="Enums.html#/s:O4LLVM8Floating">Floating</a>
105105
</li>
106106
<li class="nav-group-task">
107107
<a href="Enums/FunctionPass.html">FunctionPass</a>
@@ -143,7 +143,7 @@
143143
<a href="Enums/RelocMode.html">RelocMode</a>
144144
</li>
145145
<li class="nav-group-task">
146-
<a href="Enums.html#/s:4LLVM6SignedO">Signed</a>
146+
<a href="Enums.html#/s:O4LLVM6Signed">Signed</a>
147147
</li>
148148
<li class="nav-group-task">
149149
<a href="Enums/StorageClass.html">StorageClass</a>
@@ -155,7 +155,7 @@
155155
<a href="Enums/ThreadLocalModel.html">ThreadLocalModel</a>
156156
</li>
157157
<li class="nav-group-task">
158-
<a href="Enums.html#/s:4LLVM8UnsignedO">Unsigned</a>
158+
<a href="Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
159159
</li>
160160
<li class="nav-group-task">
161161
<a href="Enums/Visibility.html">Visibility</a>
@@ -210,18 +210,21 @@
210210
<a href="Functions.html">Functions</a>
211211
<ul class="nav-group-tasks">
212212
<li class="nav-group-task">
213-
<a href="Functions.html#/s:4LLVM1sopAA8ConstantVyAA6SignedOGAGF">-(_:)</a>
213+
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
214214
</li>
215215
<li class="nav-group-task">
216-
<a href="Functions.html#/s:4LLVM1sopAA8ConstantVyAA8FloatingOGAGF">-(_:)</a>
216+
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
217+
</li>
218+
<li class="nav-group-task">
219+
<a href="Functions.html#/s:F4LLVM14initializeLLVMFT_T_">initializeLLVM()</a>
217220
</li>
218221
</ul>
219222
</li>
220223
<li class="nav-group-name">
221224
<a href="Protocols.html">Protocols</a>
222225
<ul class="nav-group-tasks">
223226
<li class="nav-group-task">
224-
<a href="Protocols.html#/s:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
227+
<a href="Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
225228
</li>
226229
<li class="nav-group-task">
227230
<a href="Protocols/IRGlobal.html">IRGlobal</a>
@@ -233,7 +236,7 @@
233236
<a href="Protocols/IRValue.html">IRValue</a>
234237
</li>
235238
<li class="nav-group-task">
236-
<a href="Protocols.html#/s:4LLVM30IntegralConstantRepresentationP">IntegralConstantRepresentation</a>
239+
<a href="Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
237240
</li>
238241
</ul>
239242
</li>
@@ -338,9 +341,9 @@ <h1>Classes</h1>
338341
<li class="item">
339342
<div>
340343
<code>
341-
<a name="/s:4LLVM8FunctionC"></a>
344+
<a name="/s:C4LLVM8Function"></a>
342345
<a name="//apple_ref/swift/Class/Function" class="dashAnchor"></a>
343-
<a class="token" href="#/s:4LLVM8FunctionC">Function</a>
346+
<a class="token" href="#/s:C4LLVM8Function">Function</a>
344347
</code>
345348
</div>
346349
<div class="height-container">
@@ -372,9 +375,9 @@ <h4>Declaration</h4>
372375
<li class="item">
373376
<div>
374377
<code>
375-
<a name="/s:4LLVM6ModuleC"></a>
378+
<a name="/s:C4LLVM6Module"></a>
376379
<a name="//apple_ref/swift/Class/Module" class="dashAnchor"></a>
377-
<a class="token" href="#/s:4LLVM6ModuleC">Module</a>
380+
<a class="token" href="#/s:C4LLVM6Module">Module</a>
378381
</code>
379382
</div>
380383
<div class="height-container">
@@ -402,9 +405,9 @@ <h4>Declaration</h4>
402405
<li class="item">
403406
<div>
404407
<code>
405-
<a name="/s:4LLVM7ContextC"></a>
408+
<a name="/s:C4LLVM7Context"></a>
406409
<a name="//apple_ref/swift/Class/Context" class="dashAnchor"></a>
407-
<a class="token" href="#/s:4LLVM7ContextC">Context</a>
410+
<a class="token" href="#/s:C4LLVM7Context">Context</a>
408411
</code>
409412
</div>
410413
<div class="height-container">
@@ -434,9 +437,9 @@ <h4>Declaration</h4>
434437
<li class="item">
435438
<div>
436439
<code>
437-
<a name="/s:4LLVM9IRBuilderC"></a>
440+
<a name="/s:C4LLVM9IRBuilder"></a>
438441
<a name="//apple_ref/swift/Class/IRBuilder" class="dashAnchor"></a>
439-
<a class="token" href="#/s:4LLVM9IRBuilderC">IRBuilder</a>
442+
<a class="token" href="#/s:C4LLVM9IRBuilder">IRBuilder</a>
440443
</code>
441444
</div>
442445
<div class="height-container">
@@ -468,9 +471,9 @@ <h4>Declaration</h4>
468471
<li class="item">
469472
<div>
470473
<code>
471-
<a name="/s:4LLVM3JITC"></a>
474+
<a name="/s:C4LLVM3JIT"></a>
472475
<a name="//apple_ref/swift/Class/JIT" class="dashAnchor"></a>
473-
<a class="token" href="#/s:4LLVM3JITC">JIT</a>
476+
<a class="token" href="#/s:C4LLVM3JIT">JIT</a>
474477
</code>
475478
</div>
476479
<div class="height-container">
@@ -503,9 +506,9 @@ <h4>Declaration</h4>
503506
<li class="item">
504507
<div>
505508
<code>
506-
<a name="/s:4LLVM12MemoryBufferC"></a>
509+
<a name="/s:C4LLVM12MemoryBuffer"></a>
507510
<a name="//apple_ref/swift/Class/MemoryBuffer" class="dashAnchor"></a>
508-
<a class="token" href="#/s:4LLVM12MemoryBufferC">MemoryBuffer</a>
511+
<a class="token" href="#/s:C4LLVM12MemoryBuffer">MemoryBuffer</a>
509512
</code>
510513
</div>
511514
<div class="height-container">
@@ -544,17 +547,17 @@ <h4>Declaration</h4>
544547
<li class="item">
545548
<div>
546549
<code>
547-
<a name="/s:4LLVM10ObjectFileC"></a>
550+
<a name="/s:C4LLVM10ObjectFile"></a>
548551
<a name="//apple_ref/swift/Class/ObjectFile" class="dashAnchor"></a>
549-
<a class="token" href="#/s:4LLVM10ObjectFileC">ObjectFile</a>
552+
<a class="token" href="#/s:C4LLVM10ObjectFile">ObjectFile</a>
550553
</code>
551554
</div>
552555
<div class="height-container">
553556
<div class="pointer-container"></div>
554557
<section class="section">
555558
<div class="pointer"></div>
556559
<div class="abstract">
557-
<p>An in-memory representation of a platform object file.</p>
560+
<p>An in-memory representation of a format-independent object file.</p>
558561

559562
<a href="Classes/ObjectFile.html" class="slightly-smaller">See more</a>
560563
</div>
@@ -572,9 +575,9 @@ <h4>Declaration</h4>
572575
<li class="item">
573576
<div>
574577
<code>
575-
<a name="/s:4LLVM15SectionSequenceC"></a>
578+
<a name="/s:C4LLVM15SectionSequence"></a>
576579
<a name="//apple_ref/swift/Class/SectionSequence" class="dashAnchor"></a>
577-
<a class="token" href="#/s:4LLVM15SectionSequenceC">SectionSequence</a>
580+
<a class="token" href="#/s:C4LLVM15SectionSequence">SectionSequence</a>
578581
</code>
579582
</div>
580583
<div class="height-container">
@@ -600,9 +603,9 @@ <h4>Declaration</h4>
600603
<li class="item">
601604
<div>
602605
<code>
603-
<a name="/s:4LLVM18RelocationSequenceC"></a>
606+
<a name="/s:C4LLVM18RelocationSequence"></a>
604607
<a name="//apple_ref/swift/Class/RelocationSequence" class="dashAnchor"></a>
605-
<a class="token" href="#/s:4LLVM18RelocationSequenceC">RelocationSequence</a>
608+
<a class="token" href="#/s:C4LLVM18RelocationSequence">RelocationSequence</a>
606609
</code>
607610
</div>
608611
<div class="height-container">
@@ -628,9 +631,9 @@ <h4>Declaration</h4>
628631
<li class="item">
629632
<div>
630633
<code>
631-
<a name="/s:4LLVM14SymbolSequenceC"></a>
634+
<a name="/s:C4LLVM14SymbolSequence"></a>
632635
<a name="//apple_ref/swift/Class/SymbolSequence" class="dashAnchor"></a>
633-
<a class="token" href="#/s:4LLVM14SymbolSequenceC">SymbolSequence</a>
636+
<a class="token" href="#/s:C4LLVM14SymbolSequence">SymbolSequence</a>
634637
</code>
635638
</div>
636639
<div class="height-container">
@@ -660,9 +663,9 @@ <h4>Declaration</h4>
660663
<li class="item">
661664
<div>
662665
<code>
663-
<a name="/s:4LLVM19FunctionPassManagerC"></a>
666+
<a name="/s:C4LLVM19FunctionPassManager"></a>
664667
<a name="//apple_ref/swift/Class/FunctionPassManager" class="dashAnchor"></a>
665-
<a class="token" href="#/s:4LLVM19FunctionPassManagerC">FunctionPassManager</a>
668+
<a class="token" href="#/s:C4LLVM19FunctionPassManager">FunctionPassManager</a>
666669
</code>
667670
</div>
668671
<div class="height-container">
@@ -694,9 +697,9 @@ <h4>Declaration</h4>
694697
<li class="item">
695698
<div>
696699
<code>
697-
<a name="/s:4LLVM10TargetDataC"></a>
700+
<a name="/s:C4LLVM10TargetData"></a>
698701
<a name="//apple_ref/swift/Class/TargetData" class="dashAnchor"></a>
699-
<a class="token" href="#/s:4LLVM10TargetDataC">TargetData</a>
702+
<a class="token" href="#/s:C4LLVM10TargetData">TargetData</a>
700703
</code>
701704
</div>
702705
<div class="height-container">
@@ -728,9 +731,9 @@ <h4>Declaration</h4>
728731
<li class="item">
729732
<div>
730733
<code>
731-
<a name="/s:4LLVM6TargetC"></a>
734+
<a name="/s:C4LLVM6Target"></a>
732735
<a name="//apple_ref/swift/Class/Target" class="dashAnchor"></a>
733-
<a class="token" href="#/s:4LLVM6TargetC">Target</a>
736+
<a class="token" href="#/s:C4LLVM6Target">Target</a>
734737
</code>
735738
</div>
736739
<div class="height-container">
@@ -757,9 +760,9 @@ <h4>Declaration</h4>
757760
<li class="item">
758761
<div>
759762
<code>
760-
<a name="/s:4LLVM13TargetMachineC"></a>
763+
<a name="/s:C4LLVM13TargetMachine"></a>
761764
<a name="//apple_ref/swift/Class/TargetMachine" class="dashAnchor"></a>
762-
<a class="token" href="#/s:4LLVM13TargetMachineC">TargetMachine</a>
765+
<a class="token" href="#/s:C4LLVM13TargetMachine">TargetMachine</a>
763766
</code>
764767
</div>
765768
<div class="height-container">
@@ -789,7 +792,7 @@ <h4>Declaration</h4>
789792
</section>
790793
</section>
791794
<section id="footer">
792-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-19)</p>
795+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-30)</p>
793796
<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>
794797
</section>
795798
</article>

‎docs/Classes/Context.html

Lines changed: 16 additions & 13 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> (99% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (100% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -102,7 +102,7 @@
102102
<a href="../Enums/FloatType.html">FloatType</a>
103103
</li>
104104
<li class="nav-group-task">
105-
<a href="../Enums.html#/s:4LLVM8FloatingO">Floating</a>
105+
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
106106
</li>
107107
<li class="nav-group-task">
108108
<a href="../Enums/FunctionPass.html">FunctionPass</a>
@@ -144,7 +144,7 @@
144144
<a href="../Enums/RelocMode.html">RelocMode</a>
145145
</li>
146146
<li class="nav-group-task">
147-
<a href="../Enums.html#/s:4LLVM6SignedO">Signed</a>
147+
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
148148
</li>
149149
<li class="nav-group-task">
150150
<a href="../Enums/StorageClass.html">StorageClass</a>
@@ -156,7 +156,7 @@
156156
<a href="../Enums/ThreadLocalModel.html">ThreadLocalModel</a>
157157
</li>
158158
<li class="nav-group-task">
159-
<a href="../Enums.html#/s:4LLVM8UnsignedO">Unsigned</a>
159+
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
160160
</li>
161161
<li class="nav-group-task">
162162
<a href="../Enums/Visibility.html">Visibility</a>
@@ -211,18 +211,21 @@
211211
<a href="../Functions.html">Functions</a>
212212
<ul class="nav-group-tasks">
213213
<li class="nav-group-task">
214-
<a href="../Functions.html#/s:4LLVM1sopAA8ConstantVyAA6SignedOGAGF">-(_:)</a>
214+
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
215215
</li>
216216
<li class="nav-group-task">
217-
<a href="../Functions.html#/s:4LLVM1sopAA8ConstantVyAA8FloatingOGAGF">-(_:)</a>
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>
218221
</li>
219222
</ul>
220223
</li>
221224
<li class="nav-group-name">
222225
<a href="../Protocols.html">Protocols</a>
223226
<ul class="nav-group-tasks">
224227
<li class="nav-group-task">
225-
<a href="../Protocols.html#/s:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
228+
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
226229
</li>
227230
<li class="nav-group-task">
228231
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
@@ -234,7 +237,7 @@
234237
<a href="../Protocols/IRValue.html">IRValue</a>
235238
</li>
236239
<li class="nav-group-task">
237-
<a href="../Protocols.html#/s:4LLVM30IntegralConstantRepresentationP">IntegralConstantRepresentation</a>
240+
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
238241
</li>
239242
</ul>
240243
</li>
@@ -345,9 +348,9 @@ <h1>Context</h1>
345348
<li class="item">
346349
<div>
347350
<code>
348-
<a name="/s:4LLVM7ContextC6globalACvZ"></a>
351+
<a name="/s:ZvC4LLVM7Context6globalS0_"></a>
349352
<a name="//apple_ref/swift/Variable/global" class="dashAnchor"></a>
350-
<a class="token" href="#/s:4LLVM7ContextC6globalACvZ">global</a>
353+
<a class="token" href="#/s:ZvC4LLVM7Context6globalS0_">global</a>
351354
</code>
352355
</div>
353356
<div class="height-container">
@@ -372,9 +375,9 @@ <h4>Declaration</h4>
372375
<li class="item">
373376
<div>
374377
<code>
375-
<a name="/s:4LLVM7ContextCACs13OpaquePointerV4llvm_tcfc"></a>
378+
<a name="/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_"></a>
376379
<a name="//apple_ref/swift/Method/init(llvm:)" class="dashAnchor"></a>
377-
<a class="token" href="#/s:4LLVM7ContextCACs13OpaquePointerV4llvm_tcfc">init(llvm:)</a>
380+
<a class="token" href="#/s:FC4LLVM7ContextcFT4llvmVs13OpaquePointer_S0_">init(llvm:)</a>
378381
</code>
379382
</div>
380383
<div class="height-container">
@@ -401,7 +404,7 @@ <h4>Declaration</h4>
401404
</section>
402405
</section>
403406
<section id="footer">
404-
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-19)</p>
407+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-08-30)</p>
405408
<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>
406409
</section>
407410
</article>

0 commit comments

Comments
 (0)