From feb095598c5161966a7aaca67a56203fbb40cdbb Mon Sep 17 00:00:00 2001 From: Chandler Carruth Date: Tue, 2 Aug 2016 05:49:32 +0000 Subject: [PATCH] [Inliner] Clean up doxygen comments to match modern style. llvm-svn: 277417 --- llvm/include/llvm/Transforms/IPO/InlinerPass.h | 39 ++++++++++++-------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/llvm/include/llvm/Transforms/IPO/InlinerPass.h b/llvm/include/llvm/Transforms/IPO/InlinerPass.h index 31a63ca..8041037 100644 --- a/llvm/include/llvm/Transforms/IPO/InlinerPass.h +++ b/llvm/include/llvm/Transforms/IPO/InlinerPass.h @@ -30,37 +30,34 @@ class InlineCost; class ProfileSummaryInfo; template 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: -- 2.7.4