[PHP-DOC] cvs: phpdoc /en/functions misc.xml

[Jeroen van Wolffelaar]

jeroen          Sun Sep 30 07:31:35 2001 EDT

  Modified files:              
    /phpdoc/en/functions        misc.xml 
  Log:
  Properly mark 'die' as alias of 'exit'
  
  
Index: phpdoc/en/functions/misc.xml
diff -u phpdoc/en/functions/misc.xml:1.56 phpdoc/en/functions/misc.xml:1.57
--- phpdoc/en/functions/misc.xml:1.56   Fri Sep 28 16:18:00 2001
+++ phpdoc/en/functions/misc.xml        Sun Sep 30 07:31:35 2001
@@ -1,5 +1,5 @@
 <?xml encoding="iso-8859-1"?>
-<!-- $Revision: 1.56 $ -->
+<!-- $Revision: 1.57 $ -->
  <reference id="ref.misc">
   <title>Miscellaneous functions</title>
   <titleabbrev>Misc.</titleabbrev>
@@ -239,6 +239,19 @@
    </refsect1>
   </refentry>
 
+  <refentry id="function.die">
+   <refnamediv>
+    <refname>die</refname>
+    <refpurpose>Alias of <function>exit</function></refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <para>
+     This function is an alias of <function>exit</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.eval">
    <refnamediv>
     <refname>eval</refname>
@@ -304,30 +317,37 @@
      </programlisting>
     </para>
    </refsect1>
-  </refentry>
-
-  <refentry id="function.exit">
-   <refnamediv>
-    <refname>exit</refname>
-    <refpurpose>Output a message and terminate the current script</refpurpose>
-   </refnamediv>
    <refsect1>
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
       <funcdef>void <function>exit</function></funcdef>
-      <paramdef>mixed <parameter><optional>status</optional></parameter></paramdef>
+      <paramdef>string <parameter><optional>status</optional></parameter></paramdef>
+     </funcprototype>
+     <funcprototype>
+      <funcdef>void <function>exit</function></funcdef>
+      <paramdef>int <parameter>status</parameter></paramdef>
      </funcprototype>
     </funcsynopsis>
+    <note>
+     <simpara>
+      This is not a real function, but a language construct.
+     </simpara>
+    </note>
     <simpara>
      The <function>exit</function> function terminates execution of
-     the script. It has no return value, but will use
-     <parameter>status</parameter> as its exit status, as well as
-     printing it.
+     the script. It prints <parameter>status</parameter> just before exiting.
     </simpara>
     <simpara>
-     Also aliased as <function>die</function>.
+     If <parameter>status</parameter> is an <type>integer</type>, that value
+     will be used as exit-status.
     </simpara>
+    <note>
+     <simpara>
+      The <function>die</function> function is an alias for
+      <function>exit</function>.
+     </simpara>
+    </note>
     <para>
      <example>
       <title><function>exit</function> example</title>
@@ -340,6 +360,7 @@
 
 ?&gt;
       </programlisting>
+      <!-- TODO: example with integer exit-statis -->
      </example>
     </para>
    </refsect1>