diff options
Diffstat (limited to 'llvm/bindings/ocaml/analysis/llvm_analysis.mli')
| -rw-r--r-- | llvm/bindings/ocaml/analysis/llvm_analysis.mli | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/llvm/bindings/ocaml/analysis/llvm_analysis.mli b/llvm/bindings/ocaml/analysis/llvm_analysis.mli index 7992ad1d0da..a97bd7e9e26 100644 --- a/llvm/bindings/ocaml/analysis/llvm_analysis.mli +++ b/llvm/bindings/ocaml/analysis/llvm_analysis.mli @@ -5,32 +5,31 @@ * This file is distributed under the University of Illinois Open Source * License. See LICENSE.TXT for details. * - *===----------------------------------------------------------------------=== - * - * This interface provides an ocaml API for LLVM IR analyses, the classes in - * the Analysis library. - * *===----------------------------------------------------------------------===*) +(** Intermediate representation analysis. + + This interface provides an ocaml API for LLVM IR analyses, the classes in + the Analysis library. *) (** [verify_module m] returns [None] if the module [m] is valid, and [Some reason] if it is invalid. [reason] is a string containing a - human-readable validation report. See [llvm::verifyModule]. **) + human-readable validation report. See [llvm::verifyModule]. *) external verify_module : Llvm.llmodule -> string option = "llvm_verify_module" (** [verify_function f] returns [None] if the function [f] is valid, and [Some reason] if it is invalid. [reason] is a string containing a - human-readable validation report. See [llvm::verifyFunction]. **) + human-readable validation report. See [llvm::verifyFunction]. *) external verify_function : Llvm.llvalue -> bool = "llvm_verify_function" (** [verify_module m] returns if the module [m] is valid, but prints a - validation report to [stderr] and aborts the program if it is invalid. See - [llvm::verifyModule]. **) + validation report to [stderr] and aborts the program if it is invalid. See + [llvm::verifyModule]. *) external assert_valid_module : Llvm.llmodule -> unit = "llvm_assert_valid_module" (** [verify_function f] returns if the function [f] is valid, but prints a - validation report to [stderr] and aborts the program if it is invalid. See - [llvm::verifyFunction]. **) + validation report to [stderr] and aborts the program if it is invalid. See + [llvm::verifyFunction]. *) external assert_valid_function : Llvm.llvalue -> unit = "llvm_assert_valid_function" |

