[PM/AA] Remove the function names and class names from doxygen comments

and generally clean up their formatting.

llvm-svn: 245002
This commit is contained in:
Chandler Carruth 2015-08-14 01:43:46 +00:00
parent 4ac50b08e3
commit 45cf0bf117
2 changed files with 14 additions and 15 deletions

View File

@ -23,7 +23,7 @@ namespace llvm {
class LibCallInfo; class LibCallInfo;
struct LibCallFunctionInfo; struct LibCallFunctionInfo;
/// LibCallAliasAnalysis - Alias analysis driven from LibCallInfo. /// Alias analysis driven from LibCallInfo.
struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis { struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
static char ID; // Class identification static char ID; // Class identification
@ -52,10 +52,11 @@ struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
bool runOnFunction(Function &F) override; bool runOnFunction(Function &F) override;
/// getAdjustedAnalysisPointer - This method is used when a pass implements /// This method is used when a pass implements an analysis interface through
/// an analysis interface through multiple inheritance. If needed, it /// multiple inheritance.
/// should override this to adjust the this pointer as needed for the ///
/// specified pass info. /// If needed, it should override this to adjust the this pointer as needed
/// for the specified pass info.
void *getAdjustedAnalysisPointer(const void *PI) override { void *getAdjustedAnalysisPointer(const void *PI) override {
if (PI == &AliasAnalysis::ID) if (PI == &AliasAnalysis::ID)
return (AliasAnalysis *)this; return (AliasAnalysis *)this;
@ -68,10 +69,10 @@ private:
const MemoryLocation &Loc); const MemoryLocation &Loc);
}; };
/// createLibCallAliasAnalysisPass - Create an alias analysis pass that knows /// Create an alias analysis pass that knows about the semantics of a set of
/// about the semantics of a set of libcalls specified by LCI. The newly /// libcalls specified by LCI.
/// constructed pass takes ownership of the pointer that is provided.
/// ///
/// The newly constructed pass takes ownership of the pointer that is provided.
FunctionPass *createLibCallAliasAnalysisPass(LibCallInfo *LCI); FunctionPass *createLibCallAliasAnalysisPass(LibCallInfo *LCI);
} // End of llvm namespace } // End of llvm namespace

View File

@ -17,7 +17,6 @@
#include "llvm/Pass.h" #include "llvm/Pass.h"
using namespace llvm; using namespace llvm;
// Register this pass...
char LibCallAliasAnalysis::ID = 0; char LibCallAliasAnalysis::ID = 0;
INITIALIZE_AG_PASS(LibCallAliasAnalysis, AliasAnalysis, "libcall-aa", INITIALIZE_AG_PASS(LibCallAliasAnalysis, AliasAnalysis, "libcall-aa",
"LibCall Alias Analysis", false, true, false) "LibCall Alias Analysis", false, true, false)
@ -39,9 +38,9 @@ bool LibCallAliasAnalysis::runOnFunction(Function &F) {
return false; return false;
} }
/// AnalyzeLibCallDetails - Given a call to a function with the specified /// Given a call to a function with the specified LibCallFunctionInfo, see if
/// LibCallFunctionInfo, see if we can improve the mod/ref footprint of the call /// we can improve the mod/ref footprint of the call vs the specified
/// vs the specified pointer/size. /// pointer/size.
ModRefInfo ModRefInfo
LibCallAliasAnalysis::AnalyzeLibCallDetails(const LibCallFunctionInfo *FI, LibCallAliasAnalysis::AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
ImmutableCallSite CS, ImmutableCallSite CS,
@ -117,9 +116,8 @@ LibCallAliasAnalysis::AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
return MRInfo; return MRInfo;
} }
// getModRefInfo - Check to see if the specified callsite can clobber the /// Check to see if the specified callsite can clobber the specified memory
// specified memory object. /// object.
//
ModRefInfo LibCallAliasAnalysis::getModRefInfo(ImmutableCallSite CS, ModRefInfo LibCallAliasAnalysis::getModRefInfo(ImmutableCallSite CS,
const MemoryLocation &Loc) { const MemoryLocation &Loc) {
ModRefInfo MRInfo = MRI_ModRef; ModRefInfo MRInfo = MRI_ModRef;