From dacb8a615d023cfc1086d69895b7ff5236ac4cff Mon Sep 17 00:00:00 2001 From: Chandler Carruth Date: Sat, 18 Oct 2014 23:46:17 +0000 Subject: [PATCH] Fix the other comment to use modern doxygen style and be a bit more direct. Notably, comment on the fact that the loaded type is significant in that it determines how wide of an access must be safe. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@220150 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Analysis/Loads.cpp | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/lib/Analysis/Loads.cpp b/lib/Analysis/Loads.cpp index c79c9afc0f7..13be270a852 100644 --- a/lib/Analysis/Loads.cpp +++ b/lib/Analysis/Loads.cpp @@ -53,10 +53,14 @@ static bool AreEquivalentAddressValues(const Value *A, const Value *B) { return false; } -/// isSafeToLoadUnconditionally - Return true if we know that executing a load -/// from this value cannot trap. If it is not obviously safe to load from the -/// specified pointer, we do a quick local scan of the basic block containing -/// ScanFrom, to determine if the address is already accessed. +/// \brief Check if executing a load of this pointer value cannot trap. +/// +/// If it is not obviously safe to load from the specified pointer, we do +/// a quick local scan of the basic block containing \c ScanFrom, to determine +/// if the address is already accessed. +/// +/// This uses the pointee type to determine how many bytes need to be safe to +/// load from the pointer. bool llvm::isSafeToLoadUnconditionally(Value *V, Instruction *ScanFrom, unsigned Align, const DataLayout *TD) { int64_t ByteOffset = 0;