Add brief doxygen comments for AliasResult enum values.
authorDan Gohman <gohman@apple.com>
Thu, 11 Nov 2010 16:37:38 +0000 (16:37 +0000)
committerDan Gohman <gohman@apple.com>
Thu, 11 Nov 2010 16:37:38 +0000 (16:37 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@118792 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Analysis/AliasAnalysis.h

index 302204e41b2de1f2d694a0be1c5348a455fdb00b..12840b33a8fff8a0088628961cffa87c93689416 100644 (file)
@@ -129,7 +129,11 @@ public:
   /// See docs/AliasAnalysis.html for more information on the specific meanings
   /// of these values.
   ///
-  enum AliasResult { NoAlias = 0, MayAlias = 1, MustAlias = 2 };
+  enum AliasResult {
+    NoAlias = 0,        ///< No dependencies.
+    MayAlias = 1,       ///< Anything goes.
+    MustAlias = 2       ///< Pointers are equal.
+  };
 
   /// alias - The main low level interface to the alias analysis implementation.
   /// Returns an AliasResult indicating whether the two pointers are aliased to