Started doc tests for context.rs; Code cleanup

Author: TheDan64

src/context.rs

@@ -30,6 +30,15 @@ impl Context {
         }
     }
 
+    /// Creates a new `Context`.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use inkwell::context::Context;
+    ///
+    /// let context = Context::create();
+    /// ```
     pub fn create() -> Self {
         let context = unsafe {
             LLVMContextCreate()
@@ -38,6 +47,15 @@ impl Context {
         Context::new(context)
     }
 
+    /// Creates a `ContextRef` which references the global context singleton.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use inkwell::context::Context;
+    ///
+    /// let context = Context::get_global();
+    /// ```
     pub fn get_global() -> ContextRef {
         let context = unsafe {
             LLVMGetGlobalContext()
@@ -46,6 +64,16 @@ impl Context {
         ContextRef::new(Context::new(context))
     }
 
+    /// Creates a new `Builder` for a `Context`.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use inkwell::context::Context;
+    ///
+    /// let context = Context::create();
+    /// let builder = context.create_builder();
+    /// ```
     pub fn create_builder(&self) -> Builder {
         let builder = unsafe {
             LLVMCreateBuilderInContext(self.context)
@@ -54,6 +82,16 @@ impl Context {
         Builder::new(builder)
     }
 
+    /// Creates a new `Module` for a `Context`.
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// use inkwell::context::Context;
+    ///
+    /// let context = Context::create();
+    /// let module = context.create_module("my_module");
+    /// ```
     pub fn create_module(&self, name: &str) -> Module {
         let c_string = CString::new(name).expect("Conversion to CString failed unexpectedly");
 

src/data_layout.rs

@@ -37,7 +37,7 @@ impl PartialEq for DataLayout {
 impl fmt::Debug for DataLayout {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         write!(f, "DataLayout {{\n    ")?;
-        write!(f, "address: {:?}\n    ", self.data_layout.get());
+        write!(f, "address: {:?}\n    ", self.data_layout.get())?;
         write!(f, "repr: {:?}\n}}", self.as_str())
     }
 }

src/module.rs

@@ -1,6 +1,6 @@
 use llvm_sys::analysis::{LLVMVerifyModule, LLVMVerifierFailureAction};
 use llvm_sys::bit_writer::{LLVMWriteBitcodeToFile, LLVMWriteBitcodeToMemoryBuffer, LLVMWriteBitcodeToFD};
-use llvm_sys::core::{LLVMAddFunction, LLVMAddGlobal, LLVMDisposeMessage, LLVMDumpModule, LLVMGetNamedFunction, LLVMGetTypeByName, LLVMSetDataLayout, LLVMSetInitializer, LLVMSetTarget, LLVMCloneModule, LLVMDisposeModule, LLVMGetTarget, LLVMGetDataLayout, LLVMModuleCreateWithName, LLVMGetModuleContext, LLVMGetFirstFunction, LLVMGetLastFunction, LLVMSetLinkage, LLVMAddGlobalInAddressSpace, LLVMPrintModuleToString, LLVMGetNamedMetadataNumOperands, LLVMAddNamedMetadataOperand, LLVMGetNamedMetadataOperands, LLVMDisposeModuleProvider, LLVMCreateModuleProviderForExistingModule};
+use llvm_sys::core::{LLVMAddFunction, LLVMAddGlobal, LLVMDisposeMessage, LLVMDumpModule, LLVMGetNamedFunction, LLVMGetTypeByName, LLVMSetDataLayout, LLVMSetInitializer, LLVMSetTarget, LLVMCloneModule, LLVMDisposeModule, LLVMGetTarget, LLVMGetDataLayout, LLVMModuleCreateWithName, LLVMGetModuleContext, LLVMGetFirstFunction, LLVMGetLastFunction, LLVMSetLinkage, LLVMAddGlobalInAddressSpace, LLVMPrintModuleToString, LLVMGetNamedMetadataNumOperands, LLVMAddNamedMetadataOperand, LLVMGetNamedMetadataOperands};
 use llvm_sys::execution_engine::{LLVMCreateJITCompilerForModule, LLVMCreateMCJITCompilerForModule};
 use llvm_sys::prelude::{LLVMValueRef, LLVMModuleRef};
 use llvm_sys::LLVMLinkage;
@@ -16,7 +16,6 @@ use context::{Context, ContextRef};
 use data_layout::DataLayout;
 use execution_engine::ExecutionEngine;
 use memory_buffer::MemoryBuffer;
-use passes::PassManager;
 use types::{AsTypeRef, BasicType, FunctionType, BasicTypeEnum};
 use values::{AsValueRef, BasicValue, FunctionValue, PointerValue, MetadataValue, BasicMetadataValueEnum};
 

src/values/instruction_value.rs

@@ -6,7 +6,7 @@ use basic_block::BasicBlock;
 use values::traits::AsValueRef;
 use values::Value;
 
-// REVIEW: Metadata on instructions?
+// REVIEW: Split up into structs for SubTypes on InstructionValues?
 // REVIEW: This should maybe be split up into InstructionOpcode and ConstOpcode?
 // see LLVMGetConstOpcode
 #[derive(Debug, PartialEq, Eq)]