[PM/AA] Remove the function names and class names from doxygen comments
[oota-llvm.git] / include / llvm / Analysis / LibCallAliasAnalysis.h
index 36d9e063312faaf157c2ca105acddda3db96afe4..5193958ff4c01c82fb79d5b02ef626f95c6a9437 100644 (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,6 +69,12 @@ private:
                                    const MemoryLocation &Loc);
 };
 
+/// 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
 
 #endif