Remove tabs.
[oota-llvm.git] / bindings / ocaml / bitreader / llvm_bitreader.mli
index f6fc7b8dcda9b28b612c1a50e387d16b69fcef4a..573de5e983055a7bb6080e328496f2879127063a 100644 (file)
@@ -5,26 +5,24 @@
  * This file is distributed under the University of Illinois Open Source
  * License. See LICENSE.TXT for details.
  *
- *===----------------------------------------------------------------------===
- *
- * This interface provides an ocaml API for the LLVM bitcode reader, the
- * classes in the Bitreader library.
- *
  *===----------------------------------------------------------------------===*)
 
+(** Bitcode reader.
+
+    This interface provides an ocaml API for the LLVM bitcode reader, the
+    classes in the Bitreader library. *)
 
 exception Error of string
 
-(** [read_bitcode_file path] reads the bitcode for a new module [m] from the
-    file at [path]. Returns [Success m] if successful, and [Failure msg]
-    otherwise, where [msg] is a description of the error encountered.
-    See the function [llvm::getBitcodeModuleProvider]. **)
-external get_module_provider : Llvm.llmemorybuffer -> Llvm.llmoduleprovider
-                             = "llvm_get_module_provider"
+(** [get_module context mb] reads the bitcode for a new module [m] from the
+    memory buffer [mb] in the context [context].  Returns [m] if successful, or
+    raises [Error msg] otherwise, where [msg] is a description of the error
+    encountered. See the function [llvm::getBitcodeModule]. *)
+val get_module : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule
+
 
-(** [parse_bitcode mb] parses the bitcode for a new module [m] from the memory
-    buffer [mb]. Returns [Success m] if successful, and [Failure msg] otherwise,
-    where [msg] is a description of the error encountered.
-    See the function [llvm::ParseBitcodeFile]. **)
-external parse_bitcode : Llvm.llmemorybuffer -> Llvm.llmodule
-                       = "llvm_parse_bitcode"
+(** [parse_bitcode context mb] parses the bitcode for a new module [m] from the
+    memory buffer [mb] in the context [context]. Returns [m] if successful, or
+    raises [Error msg] otherwise, where [msg] is a description of the error
+    encountered. See the function [llvm::ParseBitcodeFile]. *)
+val parse_bitcode : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule