Skip to content

Commit 58a027b

Browse files
harlanhaskinsharlanhaskins
committed
Updated docs
1 parent 2347434 commit 58a027b

File tree

122 files changed

+3034
-1320
lines changed

Some content is hidden

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

122 files changed

+3034
-1320
lines changed

‎docs/Classes.html

Lines changed: 42 additions & 5 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> (35% documented)</p>
16+
<p><a href="index.html"> Docs</a> (51% documented)</p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
@@ -317,10 +317,18 @@ <h4>Declaration</h4>
317317
<section class="section">
318318
<div class="pointer"></div>
319319
<div class="abstract">
320-
<p>Undocumented</p>
320+
<p>A <code>Context</code> represents execution states for the core LLVM IR system.</p>
321321

322322
<a href="Classes/Context.html" class="slightly-smaller">See more</a>
323323
</div>
324+
<div class="declaration">
325+
<h4>Declaration</h4>
326+
<div class="language">
327+
<p class="aside-title">Swift</p>
328+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Context</span></code></pre>
329+
330+
</div>
331+
</div>
324332
</section>
325333
</div>
326334
</li>
@@ -337,10 +345,20 @@ <h4>Declaration</h4>
337345
<section class="section">
338346
<div class="pointer"></div>
339347
<div class="abstract">
340-
<p>Undocumented</p>
348+
<p>A <code>Module</code> represents the top-level structure of an LLVM program. An LLVM
349+
module is effectively a translation unit or a collection of translation
350+
units merged together.</p>
341351

342352
<a href="Classes/Module.html" class="slightly-smaller">See more</a>
343353
</div>
354+
<div class="declaration">
355+
<h4>Declaration</h4>
356+
<div class="language">
357+
<p class="aside-title">Swift</p>
358+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Module</span></code></pre>
359+
360+
</div>
361+
</div>
344362
</section>
345363
</div>
346364
</li>
@@ -395,10 +413,19 @@ <h4>Declaration</h4>
395413
<section class="section">
396414
<div class="pointer"></div>
397415
<div class="abstract">
398-
<p>Undocumented</p>
416+
<p>A <code>Target</code> object represents an object that encapsulates information about
417+
a host architecture, vendor, ABI, etc.</p>
399418

400419
<a href="Classes/Target.html" class="slightly-smaller">See more</a>
401420
</div>
421+
<div class="declaration">
422+
<h4>Declaration</h4>
423+
<div class="language">
424+
<p class="aside-title">Swift</p>
425+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Target</span></code></pre>
426+
427+
</div>
428+
</div>
402429
</section>
403430
</div>
404431
</li>
@@ -415,10 +442,20 @@ <h4>Declaration</h4>
415442
<section class="section">
416443
<div class="pointer"></div>
417444
<div class="abstract">
418-
<p>Undocumented</p>
445+
<p>A <code>TargetMachine</code> object represents an object that encapsulates information
446+
about a particular machine (i.e. CPU type) associated with a target
447+
environment.</p>
419448

420449
<a href="Classes/TargetMachine.html" class="slightly-smaller">See more</a>
421450
</div>
451+
<div class="declaration">
452+
<h4>Declaration</h4>
453+
<div class="language">
454+
<p class="aside-title">Swift</p>
455+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">TargetMachine</span></code></pre>
456+
457+
</div>
458+
</div>
422459
</section>
423460
</div>
424461
</li>

‎docs/Classes/Context.html

Lines changed: 26 additions & 4 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> (35% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (51% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
@@ -217,7 +217,13 @@
217217
<section>
218218
<section class="section">
219219
<h1>Context</h1>
220-
<p>Undocumented</p>
220+
<div class="declaration">
221+
<div class="language">
222+
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Context</span></code></pre>
223+
224+
</div>
225+
</div>
226+
<p>A <code>Context</code> represents execution states for the core LLVM IR system.</p>
221227

222228
</section>
223229
<section class="section task-group-section">
@@ -236,8 +242,16 @@ <h1>Context</h1>
236242
<section class="section">
237243
<div class="pointer"></div>
238244
<div class="abstract">
239-
<p>Undocumented</p>
245+
<p>Retrieves the global context instance.</p>
246+
247+
</div>
248+
<div class="declaration">
249+
<h4>Declaration</h4>
250+
<div class="language">
251+
<p class="aside-title">Swift</p>
252+
<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>
240253

254+
</div>
241255
</div>
242256
</section>
243257
</div>
@@ -255,8 +269,16 @@ <h1>Context</h1>
255269
<section class="section">
256270
<div class="pointer"></div>
257271
<div class="abstract">
258-
<p>Undocumented</p>
272+
<p>Creates a <code>Context</code> object from an <code>LLVMContextRef</code> object.</p>
273+
274+
</div>
275+
<div class="declaration">
276+
<h4>Declaration</h4>
277+
<div class="language">
278+
<p class="aside-title">Swift</p>
279+
<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>
259280

281+
</div>
260282
</div>
261283
</section>
262284
</div>

‎docs/Classes/Function.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="Function Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html"> Docs</a> (35% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (51% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">

‎docs/Classes/FunctionPassManager.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="FunctionPassManager Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html"> Docs</a> (35% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (51% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">

‎docs/Classes/IRBuilder.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<a title="IRBuilder Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html"> Docs</a> (35% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (51% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">

0 commit comments

Comments
 (0)