diff options
| author | Gordon Henriksen <gordonhenriksen@mac.com> | 2008-03-09 07:17:38 +0000 |
|---|---|---|
| committer | Gordon Henriksen <gordonhenriksen@mac.com> | 2008-03-09 07:17:38 +0000 |
| commit | 3b646de03668fed630f4e3fa9df56a7332a905e4 (patch) | |
| tree | 15785224d9e8e272182d4bf8976d8b8b4bf23f52 /bindings/ocaml/bitreader/llvm_bitreader.mli | |
| parent | afb23f48a4f5f76b4a0fca870ae5a28c27dde028 (diff) | |
| download | llvm-3b646de03668fed630f4e3fa9df56a7332a905e4.tar.gz llvm-3b646de03668fed630f4e3fa9df56a7332a905e4.tar.bz2 llvm-3b646de03668fed630f4e3fa9df56a7332a905e4.tar.xz | |
This patch cleans up the OCaml bindings so that they format nicely with
ocamldoc. It does not yet hook into the build system, though.
Patch by Erick Tryzelaar!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48095 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'bindings/ocaml/bitreader/llvm_bitreader.mli')
| -rw-r--r-- | bindings/ocaml/bitreader/llvm_bitreader.mli | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/bindings/ocaml/bitreader/llvm_bitreader.mli b/bindings/ocaml/bitreader/llvm_bitreader.mli index f6fc7b8dcd..15b389bb83 100644 --- a/bindings/ocaml/bitreader/llvm_bitreader.mli +++ b/bindings/ocaml/bitreader/llvm_bitreader.mli @@ -5,26 +5,25 @@ * 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]. **) + See the function [llvm::getBitcodeModuleProvider]. *) external get_module_provider : Llvm.llmemorybuffer -> Llvm.llmoduleprovider = "llvm_get_module_provider" (** [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]. **) + See the function [llvm::ParseBitcodeFile]. *) external parse_bitcode : Llvm.llmemorybuffer -> Llvm.llmodule = "llvm_parse_bitcode" |