Document Use

Author: CodaFi

Sources/LLVMSwift/Module.swift

@@ -104,8 +104,8 @@ public final class Module {
     }
   }
 
-  /// Creates a type with the given name in this module if that name does not
-  /// conflict with an existing type name.
+  /// Searches for and retrieves a type with the given name in this module if
+  /// that name references an existing type.
   ///
   /// - parameter name: The name of the type to create.
   ///
@@ -116,8 +116,8 @@ public final class Module {
     return convertType(type)
   }
 
-  /// Creates a function with the given name in this module if that name does 
-  /// not conflict with an existing type name.
+  /// Searches for and retrieves a function with the given name in this module 
+  /// if that name references an existing function.
   ///
   /// - parameter name: The name of the function to create.
   ///

Sources/LLVMSwift/Use.swift

@@ -1,18 +1,23 @@
 import cllvm
 
+/// `Use` represents an iterator over the uses and users of a particular value
+/// in an LLVM program.
 public struct Use {
-    internal let llvm: LLVMUseRef
-    
-    public func next() -> Use? {
-        guard let next = LLVMGetNextUse(llvm) else { return nil }
-        return Use(llvm: next)
-    }
-    
-    public func user() -> IRValue? {
-        return LLVMGetUser(llvm)
-    }
-    
-    public func usedValue() -> IRValue? {
-        return LLVMGetUsedValue(llvm)
-    }
+  internal let llvm: LLVMUseRef
+
+  /// Retrieves the next use of a value.
+  public func next() -> Use? {
+    guard let next = LLVMGetNextUse(llvm) else { return nil }
+    return Use(llvm: next)
+  }
+
+  /// Obtain the user value for this `User` object.
+  public func user() -> IRValue? {
+    return LLVMGetUser(llvm)
+  }
+
+  /// Obtain the value this `User` object corresponds to.
+  public func usedValue() -> IRValue? {
+    return LLVMGetUsedValue(llvm)
+  }
 }