[llvm] 185e9b0 - [Attributor][NFC] Improve documentation

[Johannes Doerfert via llvm-commits]

Author: Johannes Doerfert
Date: 2020-02-11T11:19:34-06:00
New Revision: 185e9b083eba20e612642a5a81816d492bb9dfba

URL: https://github.com/llvm/llvm-project/commit/185e9b083eba20e612642a5a81816d492bb9dfba
DIFF: https://github.com/llvm/llvm-project/commit/185e9b083eba20e612642a5a81816d492bb9dfba.diff

LOG: [Attributor][NFC] Improve documentation

Added: 
    

Modified: 
    llvm/lib/Transforms/IPO/Attributor.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/lib/Transforms/IPO/Attributor.cpp b/llvm/lib/Transforms/IPO/Attributor.cpp
index 3aebc97a8635..4c0185de3f04 100644
--- a/llvm/lib/Transforms/IPO/Attributor.cpp
+++ b/llvm/lib/Transforms/IPO/Attributor.cpp
@@ -374,7 +374,8 @@ static Value *constructPointer(Type *ResTy, Value *Ptr, int64_t Offset,
 /// will be done by looking through cast instructions, selects, phis, and calls
 /// with the "returned" attribute. Once we cannot look through the value any
 /// further, the callback \p VisitValueCB is invoked and passed the current
-/// value, the \p State, and a flag to indicate if we stripped anything. To
+/// value, the \p State, and a flag to indicate if we stripped anything (=the
+/// value used for the callback is not the value associated with \p IRP). To
 /// limit how much effort is invested, we will never visit more values than
 /// specified by \p MaxValues.
 template <typename AAType, typename StateTy>