OCaml bindings: formatting

[oota-llvm.git] / bindings / ocaml / analysis / llvm_analysis.mli

diff --git a/bindings/ocaml/analysis/llvm_analysis.mli b/bindings/ocaml/analysis/llvm_analysis.mli
index fdaffb7142e2246770e66445b630b95980cb7773..1a0af02b387849f1e1ace224525038d5f418334b 100644 (file)
--- a/bindings/ocaml/analysis/llvm_analysis.mli
+++ b/bindings/ocaml/analysis/llvm_analysis.mli
@@ -1,36 +1,46 @@
-(*===-- llvm_analysis.mli - LLVM Ocaml Interface ----------------*- C++ -*-===*
+(*===-- llvm_analysis.mli - LLVM OCaml Interface ----------------*- C++ -*-===*
  *
  *                     The LLVM Compiler Infrastructure
  *
- * This file was developed by Gordon Henriksen and 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.
+ * This file is distributed under the University of Illinois Open Source
+ * License. See LICENSE.TXT for details.
  *
  *===----------------------------------------------------------------------===*)
 
+(** 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"
+
+(** [view_function_cfg f] opens up a ghostscript window displaying the CFG of
+    the current function with the code for each basic block inside.
+    See [llvm::Function::viewCFG]. *)
+external view_function_cfg : Llvm.llvalue -> unit = "llvm_view_function_cfg"
+
+(** [view_function_cfg_only f] works just like [view_function_cfg], but does not
+    include the contents of basic blocks into the nodes.
+    See [llvm::Function::viewCFGOnly]. *)
+external view_function_cfg_only : Llvm.llvalue -> unit
+                                = "llvm_view_function_cfg_only"