typo
[oota-llvm.git] / include / llvm / CallingConv.h
index 6da5482f454ff6f4690fc02b43cdd518ebcd0235..072f7c3863027aaa0430f30e71a90acf188fe77f 100644 (file)
@@ -2,13 +2,12 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
-// This file defines a set of enums which specify the assigned numeric values
-// for known llvm calling conventions.
+// This file defines LLVM's set of calling conventions. 
 //
 //===----------------------------------------------------------------------===//
 
@@ -21,20 +20,22 @@ namespace llvm {
 /// the well-known calling conventions.
 ///
 namespace CallingConv {
+  /// A set of enums which specify the assigned numeric values for known llvm 
+  /// calling conventions.
+  /// @brief LLVM Calling Convention Representation
   enum ID {
-    // C - The default llvm calling convention, compatible with C.  This
-    // convention is the only calling convention that supports varargs calls.
-    // As with typical C calling conventions, the callee/caller have to tolerate
-    // certain amounts of prototype mismatch.
+    /// C - The default llvm calling convention, compatible with C.  This
+    /// convention is the only calling convention that supports varargs calls.
+    /// As with typical C calling conventions, the callee/caller have to 
+    /// tolerate certain amounts of prototype mismatch.
     C = 0,
-
-
+    
     // Generic LLVM calling conventions.  None of these calling conventions
     // support varargs calls, and all assume that the caller and callee
     // prototype exactly match.
 
-    // Fast - This calling convention attempts to make calls as fast as possible
-    // (e.g. by passing things in registers).
+    /// Fast - This calling convention attempts to make calls as fast as 
+    /// possible (e.g. by passing things in registers).
     Fast = 8,
 
     // Cold - This calling convention attempts to make code in the caller as
@@ -46,6 +47,17 @@ namespace CallingConv {
     // Target - This is the start of the target-specific calling conventions,
     // e.g. fastcall and thiscall on X86.
     FirstTargetCC = 64,
+
+    /// X86_StdCall - stdcall is the calling conventions mostly used by the
+    /// Win32 API. It is basically the same as the C convention with the
+    /// difference in that the callee is responsible for popping the arguments
+    /// from the stack.
+    X86_StdCall = 64,
+
+    /// X86_FastCall - 'fast' analog of X86_StdCall. Passes first two arguments
+    /// in ECX:EDX registers, others - via stack. Callee is responsible for
+    /// stack cleaning.
+    X86_FastCall = 65
   };
 } // End CallingConv namespace