[PATCH] D77884: fix the documentation for ocaml bindings

[Jason Hu via Phabricator via llvm-commits]

HuStmpHrrr created this revision.
HuStmpHrrr added reviewers: jhenderson, aqjune, gribozavr, whitequark, chandlerc.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Certain texts are wrong.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D77884

Files:
  llvm/bindings/ocaml/analysis/llvm_analysis.mli
  llvm/bindings/ocaml/llvm/llvm.mli


Index: llvm/bindings/ocaml/llvm/llvm.mli
===================================================================
--- llvm/bindings/ocaml/llvm/llvm.mli
+++ llvm/bindings/ocaml/llvm/llvm.mli
@@ -917,8 +917,9 @@
     See the method [llvm::ConstantInt::get]. *)
 val const_int : lltype -> int -> llvalue
 
-(** [const_of_int64 ty i] returns the integer constant of type [ty] and value
-    [i]. See the method [llvm::ConstantInt::get]. *)
+(** [const_of_int64 ty i s] returns the integer constant of type [ty] and value
+    [i]. [s] indicates whether the integer is signed or not.
+    See the method [llvm::ConstantInt::get]. *)
 val const_of_int64 : lltype -> Int64.t -> bool -> llvalue
 
 (** [int64_of_const c] returns the int64 value of the [c] constant integer.
Index: llvm/bindings/ocaml/analysis/llvm_analysis.mli
===================================================================
--- llvm/bindings/ocaml/analysis/llvm_analysis.mli
+++ llvm/bindings/ocaml/analysis/llvm_analysis.mli
@@ -16,9 +16,8 @@
     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]. *)
+(** [verify_function f] returns [true] if the function [f] is valid, and
+    [false] if it is invalid. 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


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D77884.256595.patch
Type: text/x-patch
Size: 1652 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200410/a064e623/attachment.bin>