[PM/AA] Clean up the SCEV-AA comment formatting and typos.

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

diff --git a/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h b/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h
index cedd5cafb48062cda56b541a75bd676826392ee6..a8bcbde479d3f6d1fdd24f01a813baf375fc9ca7 100644 (file)
--- a/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h
+++ b/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h
@@ -23,8 +23,8 @@
 
 namespace llvm {
 
 
 namespace llvm {
 

-/// ScalarEvolutionAliasAnalysis - This is a simple alias analysis
-/// implementation that uses ScalarEvolution to answer queries.
+/// A simple alias analysis implementation that uses ScalarEvolution to answer
+/// queries.

 class ScalarEvolutionAliasAnalysis : public FunctionPass, public AliasAnalysis {
   ScalarEvolution *SE;
 
 class ScalarEvolutionAliasAnalysis : public FunctionPass, public AliasAnalysis {
   ScalarEvolution *SE;
 


@@ -35,10 +35,11 @@ public:
         *PassRegistry::getPassRegistry());
   }
 
         *PassRegistry::getPassRegistry());
   }
 

-  /// getAdjustedAnalysisPointer - This method is used when a pass implements
-  /// an analysis interface through multiple inheritance.  If needed, it
-  /// should override this to adjust the this pointer as needed for the
-  /// specified pass info.
+  /// This method is used when a pass implements an analysis interface through
+  /// multiple inheritance.
+  ///
+  /// If needed, it should override this to adjust the this pointer as needed
+  /// for the specified pass info.

   void *getAdjustedAnalysisPointer(AnalysisID PI) override {
     if (PI == &AliasAnalysis::ID)
       return (AliasAnalysis *)this;
   void *getAdjustedAnalysisPointer(AnalysisID PI) override {
     if (PI == &AliasAnalysis::ID)
       return (AliasAnalysis *)this;


@@ -54,11 +55,7 @@ private:
   Value *GetBaseValue(const SCEV *S);
 };
 
   Value *GetBaseValue(const SCEV *S);
 };
 

-//===--------------------------------------------------------------------===//
-//
-// createScalarEvolutionAliasAnalysisPass - This pass implements a simple
-// alias analysis using ScalarEvolution queries.
-//
+/// Creates an instance of \c ScalarEvolutionAliasAnalysis.

 FunctionPass *createScalarEvolutionAliasAnalysisPass();
 
 }
 FunctionPass *createScalarEvolutionAliasAnalysisPass();
 
 }

diff --git a/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp b/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp
index 5b04f00708118b156ffb795f0bc40a8ea487698e..58d3322683a94bee809456363a657d35fbb17b53 100644 (file)
--- a/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp
+++ b/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp
@@ -48,8 +48,9 @@ bool ScalarEvolutionAliasAnalysis::runOnFunction(Function &F) {
   return false;
 }
 
   return false;
 }
 

-/// GetBaseValue - Given an expression, try to find a
-/// base value. Return null is none was found.
+/// Given an expression, try to find a base value.
+///
+/// Returns null if none was found.

 Value *ScalarEvolutionAliasAnalysis::GetBaseValue(const SCEV *S) {
   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
     // In an addrec, assume that the base will be in the start, rather
 Value *ScalarEvolutionAliasAnalysis::GetBaseValue(const SCEV *S) {
   if (const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(S)) {
     // In an addrec, assume that the base will be in the start, rather