1. Documentation upgrade.

[oota-llvm.git] / include / llvm / Assembly / AutoUpgrade.h

diff --git a/include/llvm/Assembly/AutoUpgrade.h b/include/llvm/Assembly/AutoUpgrade.h
index 39106dc8c39d2fd52e4b5398e7cf2ce84dfda381..548068fb22c1a0cb90e4832655d715e7ede1150f 100644 (file)
--- a/include/llvm/Assembly/AutoUpgrade.h
+++ b/include/llvm/Assembly/AutoUpgrade.h
@@ -19,6 +19,7 @@
 namespace llvm {
   class Function;
   class CallInst;
+  class Instruction;
 
   /// This function determines if the \p Name provides is a name for which the
   /// auto-upgrade to a non-overloaded name applies.
@@ -38,18 +39,26 @@ namespace llvm {
   /// @brief Remove overloaded intrinsic function names.
   Function* UpgradeIntrinsicFunction(Function* F);
 
-  /// This function inspects the CallInst \p CI to see if it is a call to an
-  /// old overloaded intrinsic. If it is, the CallInst's name is changed to add
-  /// a suffix that indicates the kind of arguments or result that it accepts.
   /// In LLVM 1.7, the overloading of intrinsic functions was replaced with
   /// separate functions for each of the various argument sizes. This function
   /// implements the auto-upgrade feature from old overloaded names to the new
-  /// non-overloaded names.
+  /// non-overloaded names. This function inspects the CallInst \p CI to see 
+  /// if it is a call to an old overloaded intrinsic. If it is, a new CallInst 
+  /// is created that uses the correct Function and possibly casts the 
+  /// argument and result to an unsigned type.  The caller can use the 
+  /// returned Instruction to replace the existing one. Note that the
+  /// Instruction* returned could be a CallInst or a CastInst depending on
+  /// whether casting was necessary.
   /// @param CI The CallInst to potentially auto-upgrade.
-  /// @returns True if the call was upgraded, false otherwise.
-  /// @brief Replace overloaded intrinsic function calls.
-  CallInst* UpgradeIntrinsicCall(CallInst* CI);
+  /// @returns An instrution to replace \p CI with.
+  /// @brief Get replacement instruction for overloaded intrinsic function call.
+  Instruction* UpgradeIntrinsicCall(CallInst* CI);
 
+  /// Upgrade both the function and all the calls made to it, if that function
+  /// needs to be upgraded. This is like a combination of the above two
+  /// functions, UpgradeIntrinsicFunction and UpgradeIntrinsicCall. Note that
+  /// the calls are replaced so this should only be used in a post-processing
+  /// manner (i.e. after all assembly/bytecode has been read).
   bool UpgradeCallsToIntrinsic(Function* F);
 
 } // End llvm namespace