Make comments above APIs reflect what they should do.
authorChris Lattner <sabre@nondot.org>
Sun, 11 Apr 2004 16:42:50 +0000 (16:42 +0000)
committerChris Lattner <sabre@nondot.org>
Sun, 11 Apr 2004 16:42:50 +0000 (16:42 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@12830 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Analysis/AliasAnalysis.h

index c27594171f073af48743661ebab89a5685630386..54ea494869930538cbe2b6c7cefe2255e7648918 100644 (file)
@@ -146,17 +146,17 @@ public:
 
   /// getModRefInfo - Return information about whether two call sites may refer
   /// to the same set of memory locations.  This function returns NoModRef if
-  /// the two calls refer to disjoint memory locations, Ref if they both read
-  /// some of the same memory, Mod if they both write to some of the same
-  /// memory, and ModRef if they read and write to the same memory.
+  /// the two calls refer to disjoint memory locations, Ref if CS1 reads memory
+  /// written by CS2, Mod if CS1 writes to memory read or written by CS2, or
+  /// ModRef if CS1 might read or write memory accessed by CS2.
   ///
   virtual ModRefResult getModRefInfo(CallSite CS1, CallSite CS2);
 
   /// hasNoModRefInfoForCalls - Return true if the analysis has no mod/ref
-  /// information for function calls other than "pure" and "const" functions.
-  /// This can be used by clients to avoid many pointless queries.  Remember
-  /// that if you override this and chain to another analysis, you must make
-  /// sure that it doesn't have mod/ref info either.
+  /// information for pairs of function calls (other than "pure" and "const"
+  /// functions).  This can be used by clients to avoid many pointless queries.
+  /// Remember that if you override this and chain to another analysis, you must
+  /// make sure that it doesn't have mod/ref info either.
   ///
   virtual bool hasNoModRefInfoForCalls() const { return false; }