From: Chandler Carruth <chandlerc@gmail.com>
Date: Fri, 14 Aug 2015 01:43:46 +0000 (+0000)
Subject: [PM/AA] Remove the function names and class names from doxygen comments
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=oota-llvm.git;a=commitdiff_plain;h=0d1a277d93e4cd69c75a7b91b14a152028d52ef6

[PM/AA] Remove the function names and class names from doxygen comments
and generally clean up their formatting.

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

diff --git a/include/llvm/Analysis/LibCallAliasAnalysis.h b/include/llvm/Analysis/LibCallAliasAnalysis.h
index 6a93b004501..5193958ff4c 100644
--- a/include/llvm/Analysis/LibCallAliasAnalysis.h
+++ b/include/llvm/Analysis/LibCallAliasAnalysis.h
@@ -23,7 +23,7 @@ namespace llvm {
 class LibCallInfo;
 struct LibCallFunctionInfo;
 
-/// LibCallAliasAnalysis - Alias analysis driven from LibCallInfo.
+/// Alias analysis driven from LibCallInfo.
 struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
   static char ID; // Class identification
 
@@ -52,10 +52,11 @@ struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
 
   bool runOnFunction(Function &F) override;
 
-  /// 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(const void *PI) override {
     if (PI == &AliasAnalysis::ID)
       return (AliasAnalysis *)this;
@@ -68,10 +69,10 @@ private:
                                    const MemoryLocation &Loc);
 };
 
-/// createLibCallAliasAnalysisPass - Create an alias analysis pass that knows
-/// about the semantics of a set of libcalls specified by LCI.  The newly
-/// constructed pass takes ownership of the pointer that is provided.
+/// Create an alias analysis pass that knows about the semantics of a set of
+/// libcalls specified by LCI.
 ///
+/// The newly constructed pass takes ownership of the pointer that is provided.
 FunctionPass *createLibCallAliasAnalysisPass(LibCallInfo *LCI);
 
 } // End of llvm namespace
diff --git a/lib/Analysis/LibCallAliasAnalysis.cpp b/lib/Analysis/LibCallAliasAnalysis.cpp
index 8d693dd19b4..0c58e7ca4dc 100644
--- a/lib/Analysis/LibCallAliasAnalysis.cpp
+++ b/lib/Analysis/LibCallAliasAnalysis.cpp
@@ -17,7 +17,6 @@
 #include "llvm/Pass.h"
 using namespace llvm;
   
-// Register this pass...
 char LibCallAliasAnalysis::ID = 0;
 INITIALIZE_AG_PASS(LibCallAliasAnalysis, AliasAnalysis, "libcall-aa",
                    "LibCall Alias Analysis", false, true, false)
@@ -39,9 +38,9 @@ bool LibCallAliasAnalysis::runOnFunction(Function &F) {
   return false;
 }
 
-/// AnalyzeLibCallDetails - Given a call to a function with the specified
-/// LibCallFunctionInfo, see if we can improve the mod/ref footprint of the call
-/// vs the specified pointer/size.
+/// Given a call to a function with the specified LibCallFunctionInfo, see if
+/// we can improve the mod/ref footprint of the call vs the specified
+/// pointer/size.
 ModRefInfo
 LibCallAliasAnalysis::AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
                                             ImmutableCallSite CS,
@@ -117,9 +116,8 @@ LibCallAliasAnalysis::AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
   return MRInfo;
 }
 
-// getModRefInfo - Check to see if the specified callsite can clobber the
-// specified memory object.
-//
+/// Check to see if the specified callsite can clobber the specified memory
+/// object.
 ModRefInfo LibCallAliasAnalysis::getModRefInfo(ImmutableCallSite CS,
                                                const MemoryLocation &Loc) {
   ModRefInfo MRInfo = MRI_ModRef;