Skip to content

Commit 3805d69

Browse files
committed
Updated docs
1 parent a16f1b5 commit 3805d69

File tree

164 files changed

+7230
-2396
lines changed

Some content is hidden

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

164 files changed

+7230
-2396
lines changed

Package.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import PackageDescription
22

33
let package = Package(
4-
name: "LLVM",
5-
dependencies: [
6-
.Package(url: "https://github.com/harlanhaskins/cllvm.git", majorVersion: 0),
7-
]
4+
name: "LLVM",
5+
dependencies: [
6+
.Package(url: "https://github.com/harlanhaskins/cllvm.git", majorVersion: 0),
7+
]
88
)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[![Build Status](https://travis-ci.org/harlanhaskins/LLVMSwift.svg?branch=master)](https://travis-ci.org/harlanhaskins/LLVMSwift)
2+
[![Documentation](/docs/badge.svg?raw=true)](https://harlanhaskins.github.io/LLVMSwift)
23

34
# LLVMSwift
45

Sources/LLVM/Alias.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import cllvm
22

3-
/// An `Alias` represents a global alias in an LLVM module - a new symbol and
3+
/// An `Alias` represents a global alias in an LLVM module - a new symbol and
44
/// corresponding metadata for an existing position
55
public struct Alias: IRGlobal {
66
internal let llvm: LLVMValueRef

Sources/LLVM/Function.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import cllvm
22

33
/// A `Function` represents a named function body in LLVM IR source. Functions
4-
/// in LLVM IR encapsulate a list of parameters and a sequence of basic blocks
4+
/// in LLVM IR encapsulate a list of parameters and a sequence of basic blocks
55
/// and provide a way to append to that sequence to build out its body.
66
public class Function: IRGlobal {
77
internal let llvm: LLVMValueRef
@@ -11,9 +11,9 @@ public class Function: IRGlobal {
1111

1212
/// Retrieves the entry block of this function.
1313
///
14-
/// The first basic block in a function is special in two ways: it is
14+
/// The first basic block in a function is special in two ways: it is
1515
/// immediately executed on entrance to the function, and it is not allowed to
16-
/// have predecessor basic blocks (i.e. there can not be any branches to the
16+
/// have predecessor basic blocks (i.e. there can not be any branches to the
1717
/// entry block of a function). Because the block can have no predecessors, it
1818
/// also cannot have any PHI nodes.
1919
public var entryBlock: BasicBlock? {

Sources/LLVM/IRBuilder.swift

Lines changed: 89 additions & 90 deletions
Large diffs are not rendered by default.

Sources/LLVM/IRType.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public extension IRType {
1616
/// Returns the special LLVM `undef` value for this type.
1717
///
1818
/// The `undef` value can be used anywhere a constant is expected, and
19-
/// indicates that the user of the value may receive an unspecified
19+
/// indicates that the user of the value may receive an unspecified
2020
/// bit-pattern.
2121
public func undef() -> IRValue {
2222
return LLVMGetUndef(asLLVM())

0 commit comments

Comments
 (0)