summaryrefslogtreecommitdiff
path: root/bindings/ocaml/bitwriter
diff options
context:
space:
mode:
authorGordon Henriksen <gordonhenriksen@mac.com>2008-03-09 07:17:38 +0000
committerGordon Henriksen <gordonhenriksen@mac.com>2008-03-09 07:17:38 +0000
commit3b646de03668fed630f4e3fa9df56a7332a905e4 (patch)
tree15785224d9e8e272182d4bf8976d8b8b4bf23f52 /bindings/ocaml/bitwriter
parentafb23f48a4f5f76b4a0fca870ae5a28c27dde028 (diff)
downloadllvm-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/bitwriter')
-rw-r--r--bindings/ocaml/bitwriter/llvm_bitwriter.mli11
1 files changed, 5 insertions, 6 deletions
diff --git a/bindings/ocaml/bitwriter/llvm_bitwriter.mli b/bindings/ocaml/bitwriter/llvm_bitwriter.mli
index 847eefc247..2f782a1d9f 100644
--- a/bindings/ocaml/bitwriter/llvm_bitwriter.mli
+++ b/bindings/ocaml/bitwriter/llvm_bitwriter.mli
@@ -5,15 +5,14 @@
* 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 writer, the
- * classes in the Bitwriter library.
- *
*===----------------------------------------------------------------------===*)
+(** Bitcode writer.
+
+ This interface provides an ocaml API for the LLVM bitcode writer, the
+ classes in the Bitwriter library. *)
(** [write_bitcode_file m path] writes the bitcode for module [m] to the file at
- [path]. Returns [true] if successful, [false] otherwise. **)
+ [path]. Returns [true] if successful, [false] otherwise. *)
external write_bitcode_file : Llvm.llmodule -> string -> bool
= "llvm_write_bitcode_file"