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

Chandler Carruth via llvm-commits llvm-commits at lists.llvm.org
Thu Aug 13 20:14:50 PDT 2015


Author: chandlerc
Date: Thu Aug 13 22:14:50 2015
New Revision: 245015

URL: http://llvm.org/viewvc/llvm-project?rev=245015&view=rev
Log:
[PM/AA] Clean up the SCEV-AA comment formatting and typos.

Modified:
    llvm/trunk/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h
    llvm/trunk/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp

Modified: llvm/trunk/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h?rev=245015&r1=245014&r2=245015&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h (original)
+++ llvm/trunk/include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h Thu Aug 13 22:14:50 2015
@@ -23,8 +23,8 @@
 
 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;
 
@@ -35,10 +35,11 @@ public:
         *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;
@@ -54,11 +55,7 @@ private:
   Value *GetBaseValue(const SCEV *S);
 };
 
-//===--------------------------------------------------------------------===//
-//
-// createScalarEvolutionAliasAnalysisPass - This pass implements a simple
-// alias analysis using ScalarEvolution queries.
-//
+/// Creates an instance of \c ScalarEvolutionAliasAnalysis.
 FunctionPass *createScalarEvolutionAliasAnalysisPass();
 
 }

Modified: llvm/trunk/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp?rev=245015&r1=245014&r2=245015&view=diff
==============================================================================
--- llvm/trunk/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp (original)
+++ llvm/trunk/lib/Analysis/ScalarEvolutionAliasAnalysis.cpp Thu Aug 13 22:14:50 2015
@@ -48,8 +48,9 @@ bool ScalarEvolutionAliasAnalysis::runOn
   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




More information about the llvm-commits mailing list