[llvm] r262997 - [LAA] Improve comment for isStridedPtr

[Adam Nemet via llvm-commits]

Author: anemet
Date: Tue Mar  8 23:33:19 2016
New Revision: 262997

URL: http://llvm.org/viewvc/llvm-project?rev=262997&view=rev
Log:
[LAA] Improve comment for isStridedPtr

Modified:
    llvm/trunk/include/llvm/Analysis/LoopAccessAnalysis.h

Modified: llvm/trunk/include/llvm/Analysis/LoopAccessAnalysis.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Analysis/LoopAccessAnalysis.h?rev=262997&r1=262996&r2=262997&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Analysis/LoopAccessAnalysis.h (original)
+++ llvm/trunk/include/llvm/Analysis/LoopAccessAnalysis.h Tue Mar  8 23:33:19 2016
@@ -651,8 +651,11 @@ const SCEV *replaceSymbolicStrideSCEV(Pr
                                       const ValueToValueMap &PtrToStride,
                                       Value *Ptr, Value *OrigPtr = nullptr);
 
-/// \brief Check the stride of the pointer and ensure that it does not wrap in
-/// the address space, assuming \p Preds is true.
+/// \brief If the pointer has a constant stride return it in units of its
+/// element size.  Otherwise return zero.
+///
+/// Ensure that it does not wrap in the address space, assuming \p Preds is
+/// true.
 ///
 /// If necessary this method will version the stride of the pointer according
 /// to \p PtrToStride and therefore add a new predicate to \p Preds.