10000 Merge pull request #233 from matthewseaman/update-docs-0.8 · llvm-swift/LLVMSwift@c0a77af · GitHub
[go: up one dir, main page]
Skip to content

Commit c0a77af

Browse files
matthewseamanmatthewseaman
authored
Merge pull request #233 from matthewseaman/update-docs-0.8
Update Docs for 0.8
2 parents 0712467 + d21a9ff commit c0a77af

File tree

348 files changed

+89942
-9808
lines changed

Some content is hidden

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

348 files changed

+89942
-9808
lines changed

‎Sources/LLVM/PassManager.swift

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ public class FunctionPassManager {
271271
}
272272
}
273273

274+
/// A subset of supported LLVM IR optimizer passes.
274275
@available(*, deprecated, renamed: "Pass")
275276
public typealias FunctionPass = Pass
276277

‎Sources/LLVM/PassPipeliner.swift

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ public final class PassPipeliner {
2828
private var stageMapping: [String: PipelinePlan]
2929
private var frozen: Bool = false
3030

31+
/// A helper object that can add passes to a pipeline.
32+
///
33+
/// To add a new pass, call `add(_:)`.
3134
public final class Builder {
3235
fileprivate var passes: [Pass] = []
3336

‎docs/Classes.html

Lines changed: 563 additions & 100 deletions
Large diffs are not rendered by default.

‎docs/Classes/AttachedMetadata.html

Lines changed: 88 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,21 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/swift/Class/AttachedMetadata" class="dashAnchor"></a>
1417
<a title="AttachedMetadata Class Reference"></a>
1518
<header>
1619
<div class="content-wrapper">
17-
<p><a href="../index.html">LLVM Docs</a> (100% documented)</p>
20+
<p><a href="../index.html">LLVM 0.8 Docs</a> (100% documented)</p>
21+
<p class="header-right">
22+
<form role="search" action="../search.json">
23+
<input type="text" placeholder="Search documentation" data-typeahead>
24+
</form>
25+
</p>
1826
</div>
1927
</header>
2028
<div class="content-wrapper">
@@ -39,6 +47,12 @@
3947
<li class="nav-group-task">
4048
<a href="../Classes/AttachedMetadata/Entry.html">– Entry</a>
4149
</li>
50+
<li class="nav-group-task">
51+
<a href="../Classes/BinaryFile.html">BinaryFile</a>
52+
</li>
53+
<li class="nav-group-task">
54+
<a href="../Classes/BinaryFile/Kind.html">– Kind</a>
55+
</li>
4256
<li class="nav-group-task">
4357
<a href="../Classes/Comdat.html">Comdat</a>
4458
</li>
@@ -81,6 +95,15 @@
8195
<li class="nav-group-task">
8296
<a href="../Classes/JIT.html#/s:4LLVM3JITC12ModuleHandleV">– ModuleHandle</a>
8397
</li>
98+
<li class="nav-group-task">
99+
<a href="../Classes/MDBuilder.html">MDBuilder</a>
100+
</li>
101+
<li 341A class="nav-group-task">
102+
<a href="../Classes/MachOUniversalBinaryFile.html">MachOUniversalBinaryFile</a>
103+
</li>
104+
<li class="nav-group-task">
105+
<a href="../Classes/MachOUniversalBinaryFile.html#/s:4LLVM24MachOUniversalBinaryFileC5SliceC">– Slice</a>
106+
</li>
84107
<li class="nav-group-task">
85108
<a href="../Classes/MemoryBuffer.html">MemoryBuffer</a>
86109
</li>
@@ -96,6 +119,12 @@
96119
<li class="nav-group-task">
97120
<a href="../Classes/ObjectFile.html">ObjectFile</a>
98121
</li>
122+
<li class="nav-group-task">
123+
<a href="../Classes/PassPipeliner.html">PassPipeliner</a>
124+
</li>
125+
<li class="nav-group-task">
126+
<a href="../Classes/PassPipeliner/Builder.html">– Builder</a>
127+
</li>
99128
<li class="nav-group-task">
100129
<a href="../Classes/RelocationSequence.html">RelocationSequence</a>
101130
</li>
@@ -114,6 +143,9 @@
114143
<li class="nav-group-task">
115144
<a href="../Classes/TargetMachine.html">TargetMachine</a>
116145
</li>
146+
<li class="nav-group-task">
147+
<a href="../Classes/TemporaryMDNode.html">TemporaryMDNode</a>
148+
</li>
117149
</ul>
118150
</li>
119151
<li class="nav-group-name">
@@ -131,6 +163,9 @@
131163
<li class="nav-group-task">
132164
<a href="../Enums/AttributeKind.html">AttributeKind</a>
133165
</li>
166+
<li class="nav-group-task">
167+
<a href="../Enums/BinaryFileError.html">BinaryFileError</a>
168+
</li>
134169
<li class="nav-group-task">
135170
<a href="../Enums/ByteOrder.html">ByteOrder</a>
136171
</li>
@@ -164,9 +199,6 @@
164199
<li class="nav-group-task">
165200
<a href="../Enums.html#/s:4LLVM8FloatingO">Floating</a>
166201
</li>
167-
<li class="nav-group-task">
168-
<a href="../Enums/FunctionPass.html">FunctionPass</a>
169-
</li>
170202
<li class="nav-group-task">
171203
<a href="../Enums/IRMetadataKind.html">IRMetadataKind</a>
172204
</li>
@@ -206,6 +238,9 @@
206238
<li class="nav-group-task">
207239
<a href="../Enums/OverflowBehavior.html">OverflowBehavior</a>
208240
</li>
241+
<li class="nav-group-task">
242+
<a href="../Enums/Pass.html">Pass</a>
243+
</li>
209244
<li class="nav-group-task">
210245
<a href="../Enums/RealPredicate.html">RealPredicate</a>
211246
</li>
@@ -303,7 +338,7 @@
303338
<a href="../Protocols.html#/s:4LLVM22ConstantRepresentationP">ConstantRepresentation</a>
304339
</li>
305340
<li class="nav-group-task">
306-
<a href="../Protocols.html#/s:4LLVM7DIScopeP">DIScope</a>
341+
<a href="../Protocols/DIScope.html">DIScope</a>
307342
</li>
308343
<li class="nav-group-task">
309344
<a href="../Protocols/DIType.html">DIType</a>
@@ -314,6 +349,9 @@
314349
<li class="nav-group-task">
315350
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
316351
</li>
352+
<li class="nav-group-task">
353+
<a href="../Protocols/IRInstruction.html">IRInstruction</a>
354+
</li>
317355
<li class="nav-group-task">
318356
<a href="../Protocols/IRMetadata.html">IRMetadata</a>
319357
</li>
@@ -340,6 +378,9 @@
340378
<li class="nav-group-task">
341379
<a href="../Structs/APInt.html">APInt</a>
342380
</li>
381+
<li class="nav-group-task">
382+
<a href="../Structs/AddressSpace.html">AddressSpace</a>
383+
</li>
343384
<li class="nav-group-task">
344385
<a href="../Structs/Alias.html">Alias</a>
345386
</li>
@@ -358,6 +399,9 @@
358399
<li class="nav-group-task">
359400
<a href="../Structs/Call.html">Call</a>
360401
</li>
402+
<li class="nav-group-task">
403+
<a href="../Structs/Call/TailCallKind.html">– TailCallKind</a>
404+
</li>
361405
<li class="nav-group-task">
362406
<a href="../Structs/CompileUnitMetadata.html">CompileUnitMetadata</a>
363407
</li>
@@ -421,6 +465,12 @@
421465
<li class="nav-group-task">
422466
<a href="../Structs/LocalVariableMetadata.html">LocalVariableMetadata</a>
423467
</li>
468+
<li class="nav-group-task">
469+
<a href="../Structs/MDNode.html">MDNode</a>
470+
</li>
471+
<li class="nav-group-task">
472+
<a href="../Structs/MDString.html">MDString</a>
473+
</li>
424474
<li class="nav-group-task">
425475
<a href="../Structs/MetadataType.html">MetadataType</a>
426476
</li>
@@ -469,12 +519,33 @@
469519
<li class="nav-group-task">
470520
<a href="../Structs/Symbol.html">Symbol</a>
471521
</li>
522+
<li class="nav-group-task">
523+
<a href="../Structs/TBAAStructField.html">TBAAStructField</a>
524+
</li>
472525
<li class="nav-group-task">
473526
<a href="../Structs/TerminatorInstruction.html">TerminatorInstruction</a>
474527
</li>
475528
<li class="nav-group-task">
476529
<a href="../Structs/TokenType.html">TokenType</a>
477530
</li>
531+
<li class="nav-group-task">
532+
<a href="../Structs/Triple.html">Triple</a>
533+
</li>
534+
<li class="nav-group-task">
535+
<a href="../Structs/Triple/Architecture.html">– Architecture</a>
536+
</li>
537+
<li class="nav-group-task">
538+
10000 <a href="../Structs/Triple/Vendor.html">– Vendor</a>
539+
</li>
540+
<li class="nav-group-task">
541+
<a href="../Structs/Triple/OS.html">– OS</a>
542+
</li>
543+
<li class="nav-group-task">
544+
<a href="../Structs/Triple/Environment.html">– Environment</a>
545+
</li>
546+
<li class="nav-group-task">
547+
<a href="../Structs/Triple/ObjectFormat.html">– ObjectFormat</a>
548+
</li>
478549
<li class="nav-group-task">
479550
<a href="../Structs/Use.html">Use</a>
480551
</li>
@@ -489,6 +560,14 @@
489560
</li>
490561
</ul>
491562
</li>
563+
<li class="nav-group-name">
564+
<a href="../Typealiases.html">Type Aliases</a>
565+
<ul class="nav-group-tasks">
566+
<li class="nav-group-task">
567+
<a href="../Typealiases.html#/s:4LLVM12FunctionPassa">FunctionPass</a>
568+
</li>
569+
</ul>
570+
</li>
492571
</ul>
493572
</nav>
494573
<article class="main-content">
@@ -497,6 +576,7 @@
497576
<h1>AttachedMetadata</h1>
498577
<div class="declaration">
499578
<div class="language">
579+
500580
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">AttachedMetadata</span></code></pre>
501581

502582
</div>
@@ -564,39 +644,12 @@ <h4>Declaration</h4>
564644
</section>
565645
</div>
566646
</li>
567-
<li class="item">
568-
<div>
569-
<code>
570-
<a name="/s:4LLVM16AttachedMetadataCfd"></a>
571-
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
572-
<a class="token" href="#/s:4LLVM16AttachedMetadataCfd">deinit</a>
573-
</code>
574-
</div>
575-
<div class="height-container">
576-
<div class="pointer-container"></div>
577-
<section class="section">
578-
<div class="pointer"></div>
579-
<div class="abstract">
580-
<p>Deinitialize this value and dispose of its resources.</p>
581-
582-
</div>
583-
<div class="declaration">
584-
<h4>Declaration</h4>
585-
<div class="language">
586-
<p class="aside-title">Swift</p>
587-
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
588-
589-
</div>
590-
</div>
591-
</section>
592-
</div>
593-
</li>
594647
<li class="item">
595648
<div>
596649
<code>
597650
<a name="/s:4LLVM16AttachedMetadataCyAC5EntryVSicip"></a>
598651
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
599-
<a class="token" href="#/s:4LLVM16AttachedMetadataCyAC5EntryVSicip">subscript(_:)</a>
652+
<a class="token" href="#/s:4LLVM16AttachedMetadataCyAC5EntryVSicip">subscript(_:<wbr>)</a>
600653
</code>
601654
</div>
602655
<div class="height-container">
@@ -673,8 +726,8 @@ <h4>Declaration</h4>
673726
</section>
674727
</section>
675728
<section id="footer">
676-
<p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-03-22)</p>
677-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https:/ 5B50 /realm.io" target="_blank" rel="external">Realm</a> project.</p>
729+
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-03-28)</p>
730+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
678731
</section>
679732
</article>
680733
</div>

0 commit comments

Comments
 (0)
0