Document the units for the Size field.
authorDan Gohman <gohman@apple.com>
Thu, 18 Nov 2010 17:39:01 +0000 (17:39 +0000)
committerDan Gohman <gohman@apple.com>
Thu, 18 Nov 2010 17:39:01 +0000 (17:39 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119711 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Analysis/AliasAnalysis.h

index 53f0eea2beed6944eb7f6f5abf32df179716a00b..5fe9d91776811383fb3a5d7dfb6dddd2d23257cc 100644 (file)
@@ -96,10 +96,10 @@ public:
   struct Location {
     /// Ptr - The address of the start of the location.
     const Value *Ptr;
-    /// Size - The maximum size of the location, or UnknownSize if the size is
-    /// not known.  Note that an unknown size does not mean the pointer aliases
-    /// the entire virtual address space, because there are restrictions on
-    /// stepping out of one object and into another.
+    /// Size - The maximum size of the location, in address-units, or
+    /// UnknownSize if the size is not known.  Note that an unknown size does
+    /// not mean the pointer aliases the entire virtual address space, because
+    /// there are restrictions on stepping out of one object and into another.
     /// See http://llvm.org/docs/LangRef.html#pointeraliasing
     uint64_t Size;
     /// TBAATag - The metadata node which describes the TBAA type of