sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate shmop methodsynopses based on stubs

Browse source 
Based on a patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351506 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2020-11-22 22:28:22 +00:00
parent ab9a7d2e3d
commit acf3ad4cdc
8 changed files with 44 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
appendices/resources.xml
View file

@ -1910,7 +1910,7 @@
<entry>
<function>shmop_close</function>
</entry>
<entry>Shared memory block handle (as of PHP 7.0.0)</entry>
<entry>Shared memory block handle (prior to PHP 8.0.0)</entry>
</row>
<row>
<entry>Socket</entry>

11
reference/shmop/functions/shmop-close.xml
View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>shmop_close</methodname>
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
<para>
<function>shmop_close</function> is used to close a shared memory block.
@ -20,7 +20,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>shmid</parameter></term>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block resource created by
@ -50,10 +50,10 @@
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>8.0.0</entry>
<entry>
The type of <parameter>shmid</parameter> has been changed from
<type>int</type> to <type>resource</type>.
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>
</tbody>
@ -88,7 +88,6 @@ shmop_close($shm_id);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/shmop/functions/shmop-delete.xml
View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>shmop_delete</methodname>
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
<para>
<function>shmop_delete</function> is used to delete a shared memory block.
@ -20,7 +20,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>shmid</parameter></term>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block resource created by
@ -50,10 +50,10 @@
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>8.0.0</entry>
<entry>
The type of <parameter>shmid</parameter> has been changed from
<type>int</type> to <type>resource</type>.
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>
</tbody>
@ -81,7 +81,6 @@ shmop_delete($shm_id);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

21
reference/shmop/functions/shmop-open.xml
View file

@ -8,10 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>shmop_open</methodname>
<type class="union"><type>Shmop</type><type>false</type></type><methodname>shmop_open</methodname>
<methodparam><type>int</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>flags</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam><type>int</type><parameter>permissions</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
@ -32,7 +32,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The flags that you can use:
@ -73,7 +73,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<term><parameter>permissions</parameter></term>
<listitem>
<para>
The permissions that you wish to assign to your memory segment, those
@ -102,8 +102,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On success <function>shmop_open</function> will return an resource that you can
use to access the shared memory segment you've created. &false; is
On success <function>shmop_open</function> will return a <classname>Shmop</classname> instance that you can
use to access the shared memory segment you've created. &false; is
returned on failure.
</para>
</refsect1>
@ -120,10 +120,10 @@
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>8.0.0</entry>
<entry>
The return type of <function>shmop_open</function> has been changed from
<type>int</type> to <type>resource</type>.
On success, this function returns an <classname>Shmop</classname> instance now;
previously, a <type>resource</type> was returned.
</entry>
</row>
</tbody>
@ -161,7 +161,6 @@ $shm_id = shmop_open($shm_key, "c", 0644, 100);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

21
reference/shmop/functions/shmop-read.xml
View file

@ -8,10 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>shmop_read</methodname>
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
<methodparam><type>int</type><parameter>start</parameter></methodparam>
<methodparam><type>int</type><parameter>count</parameter></methodparam>
<type>string</type><methodname>shmop_read</methodname>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
<function>shmop_read</function> will read a string from shared memory block.
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>shmid</parameter></term>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block identifier created by
@ -31,7 +31,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<term><parameter>offset</parameter></term>
<listitem>
<para>
Offset from which to start reading
@ -39,7 +39,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>count</parameter></term>
<term><parameter>size</parameter></term>
<listitem>
<para>
The number of bytes to read.
@ -69,10 +69,10 @@
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>8.0.0</entry>
<entry>
The type of <parameter>shmid</parameter> has been changed from
<type>int</type> to <type>resource</type>.
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>
</tbody>
@ -108,7 +108,6 @@ $shm_data = shmop_read($shm_id, 0, 50);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

15
reference/shmop/functions/shmop-size.xml
View file

@ -8,9 +8,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>shmop_size</methodname>
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
</methodsynopsis>
<type>int</type><methodname>shmop_size</methodname>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
</methodsynopsis>
<para>
<function>shmop_size</function> is used to get the size, in bytes of the
shared memory block.
@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>shmid</parameter></term>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block identifier created by
@ -52,10 +52,10 @@
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>8.0.0</entry>
<entry>
The type of <parameter>shmid</parameter> has been changed from
<type>int</type> to <type>resource</type>.
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>
</tbody>
@ -83,7 +83,6 @@ $shm_size = shmop_size($shm_id);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

11
reference/shmop/functions/shmop-write.xml
View file

@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>shmop_write</methodname>
<methodparam><type>resource</type><parameter>shmid</parameter></methodparam>
<methodparam><type>Shmop</type><parameter>shmop</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>shmid</parameter></term>
<term><parameter>shmop</parameter></term>
<listitem>
<para>
The shared memory block identifier created by
@ -70,10 +70,10 @@
</thead>
<tbody>
<row>
<entry>7.0.0</entry>
<entry>8.0.0</entry>
<entry>
The type of <parameter>shmid</parameter> has been changed from
<type>int</type> to <type>resource</type>.
<parameter>shmop</parameter> expects a <classname>Shmop</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>
</tbody>
@ -110,7 +110,6 @@ $shm_bytes_written = shmop_write($shm_id, $my_string, 0);
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

2
reference/shmop/setup.xml
View file

@ -26,7 +26,7 @@
<section xml:id="shmop.resources">
&reftitle.resources;
<simpara>
As of PHP 7.0.0 this extension defines the resource type
Prior to PHP 8.0.0, this extension defined the resource type
<literal>shmop</literal> which is a handle to a shared memory block.
</simpara>
</section>