sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-17 01:18:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Properly mark 'die' as alias of 'exit'

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@58749 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeroen van Wolffelaar 2001-09-30 11:31:35 +00:00
parent cf82f3872a
commit 93231199c4
1 changed files with 34 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
functions/misc.xml
View file

@ -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 @@ if (defined("CONSTANT")){ // Note that it should be quoted
</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 @@ This is a cup with my coffee in it.
</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 @@ $file = fopen ($filename, 'r')
?&gt;
</programlisting>
<!-- TODO: example with integer exit-statis -->
</example>
</para>
</refsect1>