[llvm] r277417 - [Inliner] Clean up doxygen comments to match modern style.

[Chandler Carruth via llvm-commits]

Author: chandlerc
Date: Tue Aug  2 00:49:32 2016
New Revision: 277417

URL: http://llvm.org/viewvc/llvm-project?rev=277417&view=rev
Log:
[Inliner] Clean up doxygen comments to match modern style.

Modified:
    llvm/trunk/include/llvm/Transforms/IPO/InlinerPass.h

Modified: llvm/trunk/include/llvm/Transforms/IPO/InlinerPass.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/Transforms/IPO/InlinerPass.h?rev=277417&r1=277416&r2=277417&view=diff
==============================================================================
--- llvm/trunk/include/llvm/Transforms/IPO/InlinerPass.h (original)
+++ llvm/trunk/include/llvm/Transforms/IPO/InlinerPass.h Tue Aug  2 00:49:32 2016
@@ -30,37 +30,34 @@ class InlineCost;
 class ProfileSummaryInfo;
 template <class PtrType, unsigned SmallSize> class SmallPtrSet;
 
-/// Inliner - This class contains all of the helper code which is used to
-/// perform the inlining operations that do not depend on the policy.
-///
+/// This class contains all of the helper code which is used to perform the
+/// inlining operations that do not depend on the policy.
 struct Inliner : public CallGraphSCCPass {
   explicit Inliner(char &ID);
   explicit Inliner(char &ID, bool InsertLifetime);
 
-  /// getAnalysisUsage - For this class, we declare that we require and preserve
-  /// the call graph.  If the derived class implements this method, it should
-  /// always explicitly call the implementation here.
+  /// For this class, we declare that we require and preserve the call graph.
+  /// If the derived class implements this method, it should always explicitly
+  /// call the implementation here.
   void getAnalysisUsage(AnalysisUsage &Info) const override;
 
   bool doInitialization(CallGraph &CG) override;
 
-  // Main run interface method, this implements the interface required by the
-  // Pass class.
+  /// Main run interface method, this implements the interface required by the
+  /// Pass class.
   bool runOnSCC(CallGraphSCC &SCC) override;
 
   using llvm::Pass::doFinalization;
-  // doFinalization - Remove now-dead linkonce functions at the end of
-  // processing to avoid breaking the SCC traversal.
+  /// Remove now-dead linkonce functions at the end of processing to avoid
+  /// breaking the SCC traversal.
   bool doFinalization(CallGraph &CG) override;
 
-  /// getInlineCost - This method must be implemented by the subclass to
-  /// determine the cost of inlining the specified call site.  If the cost
-  /// returned is greater than the current inline threshold, the call site is
-  /// not inlined.
-  ///
+  /// This method must be implemented by the subclass to determine the cost of
+  /// inlining the specified call site.  If the cost returned is greater than
+  /// the current inline threshold, the call site is not inlined.
   virtual InlineCost getInlineCost(CallSite CS) = 0;
 
-  /// removeDeadFunctions - Remove dead functions.
+  /// Remove dead functions.
   ///
   /// This also includes a hack in the form of the 'AlwaysInlineOnly' flag
   /// which restricts it to deleting functions with an 'AlwaysInline'
@@ -68,14 +65,14 @@ struct Inliner : public CallGraphSCCPass
   /// deal with that subset of the functions.
   bool removeDeadFunctions(CallGraph &CG, bool AlwaysInlineOnly = false);
 
-  /// This function performs the main work of the pass.  The default
-  /// of Inlinter::runOnSCC() calls skipSCC() before calling this method, but
-  /// derived classes which cannot be skipped can override that method and
-  /// call this function unconditionally.
+  /// This function performs the main work of the pass.  The default of
+  /// Inlinter::runOnSCC() calls skipSCC() before calling this method, but
+  /// derived classes which cannot be skipped can override that method and call
+  /// this function unconditionally.
   bool inlineCalls(CallGraphSCC &SCC);
 
 private:
-  // InsertLifetime - Insert @llvm.lifetime intrinsics.
+  // Insert @llvm.lifetime intrinsics.
   bool InsertLifetime;
 
 protected: