aboutsummaryrefslogtreecommitdiffstats
path: root/include/llvm/Analysis/AliasAnalysis.h
diff options
context:
space:
mode:
authorDan Gohman <gohman@apple.com>2010-11-11 16:37:38 +0000
committerDan Gohman <gohman@apple.com>2010-11-11 16:37:38 +0000
commit17e8078ae14ed71f657d59c77efa3bedf171161a (patch)
tree432a3ef6af70614ccfb7f86789a1d794f0ac0fd9 /include/llvm/Analysis/AliasAnalysis.h
parent67a84f1ee682ef8aadde635117ea6a1d16f8f6df (diff)
downloadexternal_llvm-17e8078ae14ed71f657d59c77efa3bedf171161a.zip
external_llvm-17e8078ae14ed71f657d59c77efa3bedf171161a.tar.gz
external_llvm-17e8078ae14ed71f657d59c77efa3bedf171161a.tar.bz2
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
Diffstat (limited to 'include/llvm/Analysis/AliasAnalysis.h')
-rw-r--r--include/llvm/Analysis/AliasAnalysis.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/llvm/Analysis/AliasAnalysis.h b/include/llvm/Analysis/AliasAnalysis.h
index 302204e..12840b3 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