Document Switch

Author: CodaFi

Sources/LLVMSwift/Switch.swift

@@ -1,13 +1,24 @@
 import cllvm
 
+/// A `Switch` represents a `switch` instruction.  A `switch` instruction
+/// defines a jump table of values and destination basic blocks to pass the flow
+/// of control to if a condition value matches.  If no match is made, control
+/// flow passes to the default basic block.
 public struct Switch: IRValue {
-    internal let llvm: LLVMValueRef
-    
-    public func addCase(_ value: IRValue, _ block: BasicBlock) {
-        LLVMAddCase(llvm, value.asLLVM(), block.asLLVM())
-    }
-    
-    public func asLLVM() -> LLVMValueRef {
-        return llvm
-    }
+  internal let llvm: LLVMValueRef
+
+  /// Inserts a case with the given value and destination basic block in the
+  /// jump table of this `switch` instruction.
+  ///
+  /// - parameter value: The value that acts as the selector for this case.
+  /// - parameter block: The destination block for the flow of control if this
+  ///   case is matched.
+  public func addCase(_ value: IRValue, _ block: BasicBlock) {
+    LLVMAddCase(llvm, value.asLLVM(), block.asLLVM())
+  }
+
+  /// Retrieves the underlying LLVM value object.
+  public func asLLVM() -> LLVMValueRef {
+    return llvm
+  }
 }