svn: /phpdoc/ja/trunk/reference/sem/functions/ sem-acquire.xml sem-get.xml sem-release.xml sem-remove.xml

[email protected] (Yoshinari Takaoka)
Newsgroups php.doc.ja
Message-ID <[email protected]> 
mumumu                                   Mon, 23 Nov 2020 00:51:52 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=351517

Log:
Generate sysvsem methodsynopses based on stubs

Based on a patch contributed by Máté Kocsis <[email protected]>.

Changed paths:
    U   phpdoc/ja/trunk/reference/sem/functions/sem-acquire.xml
    U   phpdoc/ja/trunk/reference/sem/functions/sem-get.xml
    U   phpdoc/ja/trunk/reference/sem/functions/sem-release.xml
    U   phpdoc/ja/trunk/reference/sem/functions/sem-remove.xml
svn-diffs-351517.txt (text/x-diff, 11 KB) 
Modified: phpdoc/ja/trunk/reference/sem/functions/sem-acquire.xml
===================================================================
--- phpdoc/ja/trunk/reference/sem/functions/sem-acquire.xml	2020-11-23 00:38:02 UTC (rev 351516)
+++ phpdoc/ja/trunk/reference/sem/functions/sem-acquire.xml	2020-11-23 00:51:52 UTC (rev 351517)
@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 343899 Maintainer: hirokawa Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.sem-acquire">
+<!-- EN-Revision: 351507 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.sem-acquire" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>sem_acquire</refname>
   <refpurpose>セマフォを得る</refpurpose>
@@ -11,8 +12,8 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>sem_acquire</methodname>
-   <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam>
-   <methodparam choice="opt"><type>bool</type><parameter>nowait</parameter><initializer>&false;</initializer></methodparam>
+   <methodparam><type>SysvSemaphore</type><parameter>semaphore</parameter></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>non_blocking</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>sem_acquire</function> はデフォルトで、(必要な場合)
@@ -32,16 +33,16 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>sem_identifier</parameter></term>
+     <term><parameter>semaphore</parameter></term>
      <listitem>
       <para>
-       <parameter>sem_identifier</parameter> はセマフォのリソースで、
+       <parameter>semaphore</parameter> はセマフォのリソースで、
        <function>sem_get</function> によって得られます。
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>nowait</parameter></term>
+     <term><parameter>non_blocking</parameter></term>
      <listitem>
       <para>
        セマフォが確保できるまでプロセスを待たせたくない場合に指定します。
@@ -74,9 +75,11 @@
      </thead>
      <tbody>
       <row>
-       <entry>5.6.1</entry>
+       <entry>8.0.0</entry>
        <entry>
-        <parameter>$nowait</parameter> パラメータが追加されました。
+        引数 <parameter>semaphore</parameter> は、
+        <classname>SysvSemaphore</classname> クラスのインスタンスを期待するようになりました。
+        これより前のバージョンでは、リソースが期待されていました。
        </entry>
       </row>
      </tbody>
@@ -96,7 +99,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/sem/functions/sem-get.xml
===================================================================
--- phpdoc/ja/trunk/reference/sem/functions/sem-get.xml	2020-11-23 00:38:02 UTC (rev 351516)
+++ phpdoc/ja/trunk/reference/sem/functions/sem-get.xml	2020-11-23 00:51:52 UTC (rev 351517)
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 349425 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351507 Maintainer: hirokawa Status: ready -->
 <!-- Credits: mumumu -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.sem-get">
+<refentry xml:id="function.sem-get" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>sem_get</refname>
   <refpurpose>セマフォ ID を得る</refpurpose>
@@ -11,11 +11,11 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>resource</type><methodname>sem_get</methodname>
+   <type class="union"><type>SysvSemaphore</type><type>false</type></type><methodname>sem_get</methodname>
    <methodparam><type>int</type><parameter>key</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>max_acquire</parameter><initializer>1</initializer></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>perm</parameter><initializer>0666</initializer></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>auto_release</parameter><initializer>1</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>permissions</parameter><initializer>0666</initializer></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>auto_release</parameter><initializer>&true;</initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>sem_get</function> は、
@@ -54,7 +54,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>perm</parameter></term>
+     <term><parameter>permissions</parameter></term>
      <listitem>
       <para>
        セマフォのパーミッション。
@@ -82,6 +82,40 @@
   </para>
  </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        成功した時、
+        この関数は <classname>SysvSemaphore</classname> クラスのインスタンスを返すようになりました。
+        期待するようになりました。
+        これより前のバージョンでは、リソースが返されていました。
+       </entry>
+      </row>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        <parameter>auto_release</parameter> の型が
+        <type>int</type> から <type>bool</type> に変更されました
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
  <refsect1 role="notes">
   &reftitle.notes;
   <warning>
@@ -106,7 +140,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/sem/functions/sem-release.xml
===================================================================
--- phpdoc/ja/trunk/reference/sem/functions/sem-release.xml	2020-11-23 00:38:02 UTC (rev 351516)
+++ phpdoc/ja/trunk/reference/sem/functions/sem-release.xml	2020-11-23 00:51:52 UTC (rev 351517)
@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.sem-release">
+<!-- EN-Revision: 351507 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.sem-release" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>sem_release</refname>
   <refpurpose>セマフォを解放する</refpurpose>
@@ -11,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>sem_release</methodname>
-   <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam>
+   <methodparam><type>SysvSemaphore</type><parameter>semaphore</parameter></methodparam>
   </methodsynopsis>
   <para>
    <function>sem_release</function> は、そのセマフォが
@@ -29,10 +30,10 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>sem_identifier</parameter></term>
+     <term><parameter>semaphore</parameter></term>
      <listitem>
       <para>
-       <function>sem_get</function> が返すセマフォリソースハンドル。
+       <function>sem_get</function> が返すセマフォ。
       </para>
      </listitem>
     </varlistentry>
@@ -47,6 +48,32 @@
   </para>
  </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        引数 <parameter>semaphore</parameter> は、
+        <classname>SysvSemaphore</classname> クラスのインスタンスを期待するようになりました。
+        これより前のバージョンでは、リソースが期待されていました。
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
@@ -58,7 +85,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/sem/functions/sem-remove.xml
===================================================================
--- phpdoc/ja/trunk/reference/sem/functions/sem-remove.xml	2020-11-23 00:38:02 UTC (rev 351516)
+++ phpdoc/ja/trunk/reference/sem/functions/sem-remove.xml	2020-11-23 00:51:52 UTC (rev 351517)
@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 304383 Maintainer: hirokawa Status: ready -->
-<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.sem-remove">
+<!-- EN-Revision: 351507 Maintainer: hirokawa Status: ready -->
+<!-- Credits: mumumu -->
+<refentry xml:id="function.sem-remove" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>sem_remove</refname>
   <refpurpose>セマフォを削除する</refpurpose>
@@ -11,7 +12,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>sem_remove</methodname>
-   <methodparam><type>resource</type><parameter>sem_identifier</parameter></methodparam>
+   <methodparam><type>SysvSemaphore</type><parameter>semaphore</parameter></methodparam>
   </methodsynopsis>
   <para>
    <function>sem_remove</function> は、指定したセマフォを削除します。
@@ -26,10 +27,10 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>sem_identifier</parameter></term>
+     <term><parameter>semaphore</parameter></term>
      <listitem>
       <para>
-       <function>sem_get</function> が返すセマフォリソース ID。
+       <function>sem_get</function> が返すセマフォ。
       </para>
      </listitem>
     </varlistentry>
@@ -44,6 +45,32 @@
   </para>
  </refsect1>

+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        引数 <parameter>semaphore</parameter> は、
+        <classname>SysvSemaphore</classname> クラスのインスタンスを期待するようになりました。
+        これより前のバージョンでは、リソースが期待されていました。
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
@@ -56,7 +83,6 @@
  </refsect1>

 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.