Add some comments.

llvm-svn: 102731
2010-04-30 18:33:41 +00:00 · 2010-04-30 18:33:41 +00:00 · be474734a5
parent 57bb73c80b
commit be474734a5
1 changed files with 3 additions and 1 deletions
--- a/llvm/include/llvm/Analysis/ScalarEvolution.h
+++ b/llvm/include/llvm/Analysis/ScalarEvolution.h
@ -651,7 +651,9 @@ namespace llvm {
                          const SCEV *LHS, const SCEV *RHS);

    /// SimplifyICmpOperands - Simplify LHS and RHS in a comparison with
-    /// predicate Pred. Return true iff any changes were made.
+    /// predicate Pred. Return true iff any changes were made. If the
+    /// operands are provably equal or inequal, LHS and RHS are set to
+    /// the same value and Pred is set to either ICMP_EQ or ICMP_NE.
    ///
    bool SimplifyICmpOperands(ICmpInst::Predicate &Pred,
                              const SCEV *&LHS,