RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-25 20:23:11 +01:00
Code Issues Projects Releases Wiki Activity

[NFC][OCaml] Fix documentation for verify_function and const_of_int64

Browse Source 
Documentation of verify_function is incorrect and that of
const_of_int64 is incomplete.

Reviewed By: whitequark

Differential Revision: https://reviews.llvm.org/D77884
This commit is contained in:
Jason Hu 2021-03-16 21:02:03 +00:00 committed by Josh Berdine
parent 2d3ee0e485
commit 4d21b9cc78
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
bindings/ocaml/analysis/llvm_analysis.mli
View File

@ -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

5
bindings/ocaml/llvm/llvm.mli
View File

@ -960,8 +960,9 @@ val metadata_as_value : llcontext -> llmetadata -> llvalue
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.