[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
This commit is contained in:
Chandler Carruth 2015-08-14 01:43:46 +00:00
parent f6f87835da
commit 0d1a277d93
2 changed files with 14 additions and 15 deletions

View File

@ -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

View File

@ -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;