diff options
author | Gordon Henriksen <gordonhenriksen@mac.com> | 2007-12-01 21:01:15 +0000 |
---|---|---|
committer | Gordon Henriksen <gordonhenriksen@mac.com> | 2007-12-01 21:01:15 +0000 |
commit | 0465fb5663a0108399df4c19db1afb4516328964 (patch) | |
tree | 8c5ee030ccde52bb6c400cf54f6e28ff352a7621 /bindings/ocaml/bitwriter/llvm_bitwriter.mli | |
parent | c8d7194b481cbdf859e3ce8ad49cd40ec86b06fe (diff) | |
download | external_llvm-0465fb5663a0108399df4c19db1afb4516328964.zip external_llvm-0465fb5663a0108399df4c19db1afb4516328964.tar.gz external_llvm-0465fb5663a0108399df4c19db1afb4516328964.tar.bz2 |
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
Diffstat (limited to 'bindings/ocaml/bitwriter/llvm_bitwriter.mli')
-rw-r--r-- | bindings/ocaml/bitwriter/llvm_bitwriter.mli | 3 |
1 files changed, 2 insertions, 1 deletions
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" |