[NFC] Consistenly use commented and annotated ScopPass functions

  The changes affect methods that are part of the Pass interface and
  include:
    - Comments that describe the methods purpose.
    - A consistent use of the keywords override and virtual.
  Additionally, the printScop method is now optional and removed from
  SCoP passes that do not implement it.

llvm-svn: 248685

2 files changed, 10 insertions, 6 deletions

diff --git a/polly/lib/Transform/DeadCodeElimination.cpp b/polly/lib/Transform/DeadCodeElimination.cpp
index 1d5ccbe5e6c..f8374d693aa 100644
--- a/polly/lib/Transform/DeadCodeElimination.cpp
+++ b/polly/lib/Transform/DeadCodeElimination.cpp
@@ -59,9 +59,10 @@ public:
   static char ID;
   explicit DeadCodeElim() : ScopPass(ID) {}
 
+  /// @brief Remove dead iterations from the schedule of @p S.
   bool runOnScop(Scop &S) override;
 
-  void printScop(raw_ostream &OS, Scop &S) const override;
+  /// @brief Register all analyses and transformation required.
   void getAnalysisUsage(AnalysisUsage &AU) const override;
 
 private:
@@ -166,8 +167,6 @@ bool DeadCodeElim::runOnScop(Scop &S) {
   return eliminateDeadCode(S, DCEPreciseSteps);
 }
 
-void DeadCodeElim::printScop(raw_ostream &, Scop &) const {}
-
 void DeadCodeElim::getAnalysisUsage(AnalysisUsage &AU) const {
   ScopPass::getAnalysisUsage(AU);
   AU.addRequired<DependenceInfo>();
diff --git a/polly/lib/Transform/ScheduleOptimizer.cpp b/polly/lib/Transform/ScheduleOptimizer.cpp
index e573a6d65b4..e81a2655eea 100644
--- a/polly/lib/Transform/ScheduleOptimizer.cpp
+++ b/polly/lib/Transform/ScheduleOptimizer.cpp
@@ -328,18 +328,23 @@ public:
 
   ~IslScheduleOptimizer() { isl_schedule_free(LastSchedule); }
 
+  /// @brief Optimize the schedule of the SCoP @p S.
   bool runOnScop(Scop &S) override;
+
+  /// @brief Print the new schedule for the SCoP @p S.
   void printScop(raw_ostream &OS, Scop &S) const override;
-  void getAnalysisUsage(AnalysisUsage &AU) const override;
 
-private:
-  isl_schedule *LastSchedule;
+  /// @brief Register all analyses and transformation required.
+  void getAnalysisUsage(AnalysisUsage &AU) const override;
 
   /// @brief Release the internal memory.
   void releaseMemory() override {
     isl_schedule_free(LastSchedule);
     LastSchedule = nullptr;
   }
+
+private:
+  isl_schedule *LastSchedule;
 };
 }