From 17e8078ae14ed71f657d59c77efa3bedf171161a Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Thu, 11 Nov 2010 16:37:38 +0000 Subject: [PATCH] Add brief doxygen comments for AliasResult enum values. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@118792 91177308-0d34-0410-b5e6-96231b3b80d8 --- include/llvm/Analysis/AliasAnalysis.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/llvm/Analysis/AliasAnalysis.h b/include/llvm/Analysis/AliasAnalysis.h index 302204e41b2..12840b33a8f 100644 --- a/include/llvm/Analysis/AliasAnalysis.h +++ b/include/llvm/Analysis/AliasAnalysis.h @@ -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