From 0465fb5663a0108399df4c19db1afb4516328964 Mon Sep 17 00:00:00 2001 From: Gordon Henriksen Date: Sat, 1 Dec 2007 21:01:15 +0000 Subject: Adding ocamldoc-style comments for the Ocaml bindings. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@44494 91177308-0d34-0410-b5e6-96231b3b80d8 --- bindings/ocaml/bitwriter/llvm_bitwriter.mli | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'bindings/ocaml/bitwriter/llvm_bitwriter.mli') diff --git a/bindings/ocaml/bitwriter/llvm_bitwriter.mli b/bindings/ocaml/bitwriter/llvm_bitwriter.mli index 08e001b..76f4b4e 100644 --- a/bindings/ocaml/bitwriter/llvm_bitwriter.mli +++ b/bindings/ocaml/bitwriter/llvm_bitwriter.mli @@ -13,6 +13,7 @@ *===----------------------------------------------------------------------===*) -(* Writes the bitcode for module the given path. Returns true if successful. *) +(** [write_bitcode_file m path] writes the bitcode for module [m] to the file at + [path]. Returns [true] if successful, [false] otherwise. **) external write_bitcode_file : Llvm.llmodule -> string -> bool = "llvm_write_bitcode_file" -- cgit v1.1