[OCaml] Documentation improvements.

Patch by Julien Sagot

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@212230 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Peter Zotov 2014-07-02 22:17:20 +00:00
parent 9c05de8a0a
commit 2c95cdc6c4

View File

@ -157,38 +157,40 @@ end
See the [llvm::ICmpInst::Predicate] enumeration. *) See the [llvm::ICmpInst::Predicate] enumeration. *)
module Icmp : sig module Icmp : sig
type t = type t =
| Eq | Eq (* Equal *)
| Ne | Ne (* Not equal *)
| Ugt | Ugt (* Unsigned greater than *)
| Uge | Uge (* Unsigned greater or equal *)
| Ult | Ult (* Unsigned less than *)
| Ule | Ule (* Unsigned less or equal *)
| Sgt | Sgt (* Signed greater than *)
| Sge | Sge (* Signed greater or equal *)
| Slt | Slt (* Signed less than *)
| Sle | Sle (* Signed less or equal *)
end end
(** The predicate for a floating-point comparison ([fcmp]) instruction. (** The predicate for a floating-point comparison ([fcmp]) instruction.
Ordered means that neither operand is a QNAN while unordered means
that either operand may be a QNAN.
See the [llvm::FCmpInst::Predicate] enumeration. *) See the [llvm::FCmpInst::Predicate] enumeration. *)
module Fcmp : sig module Fcmp : sig
type t = type t =
| False | False (* Always false *)
| Oeq | Oeq (* Ordered and equal *)
| Ogt | Ogt (* Ordered and greater than *)
| Oge | Oge (* Ordered and greater or equal *)
| Olt | Olt (* Ordered and less than *)
| Ole | Ole (* Ordered and less or equal *)
| One | One (* Ordered and not equal *)
| Ord | Ord (* Ordered (no operand is NaN) *)
| Uno | Uno (* Unordered (one operand at least is NaN) *)
| Ueq | Ueq (* Unordered and equal *)
| Ugt | Ugt (* Unordered and greater than *)
| Uge | Uge (* Unordered and greater or equal *)
| Ult | Ult (* Unordered and less than *)
| Ule | Ule (* Unordered and less or equal *)
| Une | Une (* Unordered and not equal *)
| True | True (* Always true *)
end end
(** The opcodes for LLVM instructions and constant expressions. *) (** The opcodes for LLVM instructions and constant expressions. *)