Fix #75094: Functions not documented

We document pcntl_async_signals().

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342911 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2017-08-22 15:37:18 +00:00
parent aacd13217f
commit 3292ed699a
2 changed files with 77 additions and 0 deletions

View file

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pcntl_async_signals" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>pcntl_async_signals</refname>
<refpurpose>Enable/disable asynchronous signal handling or return the old setting</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis role="procedural">
<type>bool</type><methodname>pcntl_async_signals</methodname>
<methodparam choice="opt"><type>bool</type><parameter>on</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
If the <parameter>on</parameter> parameter is omitted,
<function>pcntl_async_signals</function> returns whether asynchronous signal
handling is enabled. Otherwise, asynchronous signal handling is enabled or
disabled.
</para>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>on</parameter></term>
<listitem>
<para>
Whether asynchronous signal handling should be enabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
When used as getter (that is without the optional parameter) it returns
whether asynchronous signal handling is enabled. When used as setter (that is
with the optional parameter given), it returns whether asynchronous signal
handling was enabled <emphasis>before</emphasis> the function call.
</para>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>declare</function></member>
</simplelist>
</refsect1><!-- }}} -->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -5,6 +5,7 @@
-->
<versions>
<function name="pcntl_alarm" from="PHP 4 &gt;= 4.3.0, PHP 5, PHP 7"/>
<function name="pcntl_async_signals" from="PHP 7 &gt;= 7.1.0"/>
<function name="pcntl_errno" from="PHP 5 &gt;= 5.3.4, PHP 7"/>
<function name="pcntl_exec" from="PHP 4 &gt;= 4.2.0, PHP 5, PHP 7"/>
<function name="pcntl_fork" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7"/>