[llvm-commits] [llvm] r48721 - /llvm/trunk/docs/LangRef.html

[Devang Patel]

Author: dpatel
Date: Mon Mar 24 00:35:41 2008
New Revision: 48721

URL: http://llvm.org/viewvc/llvm-project?rev=48721&view=rev
Log:
Update Function type documentation to clarify how multiple return values are supported.

Modified:
    llvm/trunk/docs/LangRef.html

Modified: llvm/trunk/docs/LangRef.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/LangRef.html?rev=48721&r1=48720&r2=48721&view=diff

==============================================================================
--- llvm/trunk/docs/LangRef.html (original)
+++ llvm/trunk/docs/LangRef.html Mon Mar 24 00:35:41 2008
@@ -1225,8 +1225,10 @@
 <div class="doc_text">
 <h5>Overview:</h5>
 <p>The function type can be thought of as a function signature.  It
-consists of a return type and a list of formal parameter types. 
-Function types are usually used to build virtual function tables
+consists of a return type and a list of formal parameter types. The
+return type of a function type is a scalar type or a struct type. If the 
+return type is a struct type then all struct elements must be of a first 
+class type. Function types are usually used to build virtual function tables
 (which are structures of pointers to functions), for indirect function
 calls, and when defining a function.</p>
 
@@ -1260,6 +1262,11 @@
       which returns an integer.  This is the signature for <tt>printf</tt> in 
       LLVM.
     </td>
+  </tr><tr class="layout">
+    <td class="left"><tt>{i32, i32} (i32)</tt></td>
+    <td class="left">A function taking an <tt>i32></tt>, returning two values
+        <tt> i32 </tt> as an arggregate of type <tt>{ i32, i32 }</tt>
+    </td>
   </tr>
 </table>