[PM] Rename the IR printing pass header to a more generic and correct

name to match the source file which I got earlier. Update the include
sites. Also modernize the comments in the header to use the more
recommended doxygen style.

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

2 files changed, 16 insertions, 15 deletions

diff --git a/include/llvm/IR/PrintModulePass.h b/include/llvm/IR/IRPrintingPasses.h
index 3c18bd59a0..45d3c7a120 100644
--- a/include/llvm/IR/PrintModulePass.h
+++ b/include/llvm/IR/IRPrintingPasses.h
@@ -1,4 +1,4 @@
-//===- PrintModulePass.h - IR Printing Passes -------------------*- C++ -*-===//
+//===- IRPrintingPasses.h - Passes to print out IR constructs ---*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -6,13 +6,14 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
-//
-// This file defines two passes to print out a module.  The PrintModulePass pass
-// simply prints out the entire module when it is executed.  The
-// PrintFunctionPass class is designed to be pipelined with other
-// FunctionPass's, and prints out the functions of the module as they are
-// processed.
-//
+/// \file
+///
+/// This file defines passes to print out IR in various granularities. The
+/// PrintModulePass pass simply prints out the entire module when it is
+/// executed. The PrintFunctionPass class is designed to be pipelined with
+/// other FunctionPass's, and prints out the functions of the module as they
+/// are processed.
+///
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_IR_PRINTMODULEPASS_H
@@ -26,19 +27,19 @@ class ModulePass;
 class BasicBlockPass;
 class raw_ostream;
 
-/// createPrintModulePass - Create and return a pass that writes the
-/// module to the specified raw_ostream.
+/// \brief Create and return a pass that writes the module to the specified
+/// \c raw_ostream.
 ModulePass *createPrintModulePass(raw_ostream *OS, bool DeleteStream = false,
                                   const std::string &Banner = "");
 
-/// createPrintFunctionPass - Create and return a pass that prints
-/// functions to the specified raw_ostream as they are processed.
+/// \brief Create and return a pass that prints functions to the specified
+/// \c raw_ostream as they are processed.
 FunctionPass *createPrintFunctionPass(const std::string &Banner,
                                       raw_ostream *OS,
                                       bool DeleteStream = false);
 
-/// createPrintBasicBlockPass - Create and return a pass that writes the
-/// BB to the specified raw_ostream.
+/// \brief Create and return a pass that writes the BB to the specified
+/// \c raw_ostream.
 BasicBlockPass *createPrintBasicBlockPass(raw_ostream *OS,
                                           bool DeleteStream = false,
                                           const std::string &Banner = "");
diff --git a/include/llvm/LinkAllPasses.h b/include/llvm/LinkAllPasses.h
index 106267acc1..6c8c5f7ffd 100644
--- a/include/llvm/LinkAllPasses.h
+++ b/include/llvm/LinkAllPasses.h
@@ -28,7 +28,7 @@
 #include "llvm/Analysis/ScalarEvolution.h"
 #include "llvm/CodeGen/Passes.h"
 #include "llvm/IR/Function.h"
-#include "llvm/IR/PrintModulePass.h"
+#include "llvm/IR/IRPrintingPasses.h"
 #include "llvm/Transforms/IPO.h"
 #include "llvm/Transforms/Instrumentation.h"
 #include "llvm/Transforms/ObjCARC.h"