Clearer docs

Author: TomBebbington

examples/demo_3f.rs

@@ -0,0 +1,29 @@
+extern crate llvm_sys;
+extern crate llvm;
+use llvm::*;
+use llvm::Attribute::*;
+fn main() {
+    let ctx = Context::new();
+    let module = Module::new("simple", &ctx);
+    type N = f64;
+    type T = extern "C" fn(N) -> N;
+    let func = module.add_function(
+        "thr", Type::get::<T>(&ctx));
+    func.add_attributes(&[NoUnwind, ReadNone]);
+    let entry = func.append("entry");
+    let builder = Builder::new(&ctx);
+    fn n(x: N) -> N { x }
+    let three_r = n(3 as N).compile(&ctx);
+    builder.position_at_end(entry);
+    builder.build_ret(three_r);
+    module.verify().unwrap();
+
+    let ee = llvm::JitEngine::new(
+        &module, llvm::JitOptions {opt_level: 0}).unwrap();
+    println!("{:?}", module);
+    ee.with_function(func, |thr: T| {
+        for i in 0..3 {
+            println!("thr {} = {}", i, thr(0 as N))
+        }
+    });
+}

src/value.rs

@@ -238,13 +238,6 @@ impl Function {
     pub fn get_entry(&self) -> Option<&BasicBlock> {
         unsafe { mem::transmute(core::LLVMGetEntryBasicBlock(self.into())) }
     }
-    /// Returns the name of this function.
-    pub fn get_name(&self) -> &str {
-        unsafe {
-            let c_name = core::LLVMGetValueName(self.into());
-            util::to_str(c_name as *mut i8)
-        }
-    }
     /// Returns the function signature representing this function's signature.
     pub fn get_signature(&self) -> &FunctionType {
         unsafe {
@@ -338,7 +331,7 @@ pub enum Attribute {
     NoRedZone =         0b1000000000000000000,
     /// Disable implicit float instructions.
     NoImplicitFloat =   0b10000000000000000000,
-    /// Naked function.
+    /// Only allows native assembly code in the function.
     Naked =             0b100000000000000000000,
     /// The source language has marked this function as inline.
     InlineHint =        0b1000000000000000000000,