Add doxygen comments to AliasAnalysis class

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3475 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/Analysis/AliasAnalysis.h b/include/llvm/Analysis/AliasAnalysis.h
index 1fe9b21474509295b30f30c79fe3d465511ff245..64647887e513dba788db287293dfa7225f7ba142 100644 (file)
--- a/include/llvm/Analysis/AliasAnalysis.h
+++ b/include/llvm/Analysis/AliasAnalysis.h
@@ -21,41 +21,41 @@ class Instruction;
 
 struct AliasAnalysis {
 
-  // Alias analysis result - Either we know for sure that it does not alias, we
-  // know for sure it must alias, or we don't know anything: The two pointers
-  // _might_ alias.  This enum is designed so you can do things like:
-  //     if (AA.alias(P1, P2)) { ... }
-  // to check to see if two pointers might alias.
-  //
+  /// Alias analysis result - Either we know for sure that it does not alias, we
+  /// know for sure it must alias, or we don't know anything: The two pointers
+  /// _might_ alias.  This enum is designed so you can do things like:
+  ///     if (AA.alias(P1, P2)) { ... }
+  /// to check to see if two pointers might alias.
+  ///
   enum Result { NoAlias = 0, MayAlias = 1, MustAlias = 2 };
 
-  // alias - The main low level interface to the alias analysis implementation.
-  // Returns a Result indicating whether the two pointers are aliased to each
-  // other.  This is the interface that must be implemented by specific alias
-  // analysis implementations.
-  //
+  /// alias - The main low level interface to the alias analysis implementation.
+  /// Returns a Result indicating whether the two pointers are aliased to each
+  /// other.  This is the interface that must be implemented by specific alias
+  /// analysis implementations.
+  ///
   virtual Result alias(const Value *V1, const Value *V2) const = 0;
 
-  // canCallModify - Return a Result that indicates whether the specified
-  // function call can modify the memory location pointed to by Ptr.
-  //
+  /// canCallModify - Return a Result that indicates whether the specified
+  /// function call can modify the memory location pointed to by Ptr.
+  ///
   virtual Result canCallModify(const CallInst &CI, const Value *Ptr) const = 0;
 
-  // canInvokeModify - Return a Result that indicates whether the specified
-  // function invoke can modify the memory location pointed to by Ptr.
-  //
+  /// canInvokeModify - Return a Result that indicates whether the specified
+  /// function invoke can modify the memory location pointed to by Ptr.
+  ///
   virtual Result canInvokeModify(const InvokeInst &I, const Value *Ptr) const=0;
 
-  // canBasicBlockModify - Return true if it is possible for execution of the
-  // specified basic block to modify the value pointed to by Ptr.
-  //
+  /// canBasicBlockModify - Return true if it is possible for execution of the
+  /// specified basic block to modify the value pointed to by Ptr.
+  ///
   bool canBasicBlockModify(const BasicBlock &BB, const Value *Ptr) const;
 
-  // canInstructionRangeModify - Return true if it is possible for the execution
-  // of the specified instructions to modify the value pointed to by Ptr.  The
-  // instructions to consider are all of the instructions in the range of
-  // [I1,I2] INCLUSIVE.  I1 and I2 must be in the same basic block.
-  //
+  /// canInstructionRangeModify - Return true if it is possible for the
+  /// execution of the specified instructions to modify the value pointed to by
+  /// Ptr.  The instructions to consider are all of the instructions in the
+  /// range of [I1,I2] INCLUSIVE.  I1 and I2 must be in the same basic block.
+  ///
   bool canInstructionRangeModify(const Instruction &I1, const Instruction &I2,
                                  const Value *Ptr) const;