Sync some methodsynopses with stubs

php/doc-en@db22a7c
php · Apr 29, 2024 · e488001 · e488001
1 parent fef76dd
commit e488001
Show file tree

Hide file tree

Showing 17 changed files with 87 additions and 45 deletions.
diff --git a/reference/fileinfo/functions/finfo-set-flags.xml b/reference/fileinfo/functions/finfo-set-flags.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 1160ec4e7d21a2619e9661d6afe3a6356267c6c2 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: takagi Status: ready -->
 <refentry xml:id="function.finfo-set-flags" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>finfo_set_flags</refname>
@@ -11,7 +11,7 @@
   &reftitle.description;
   <para>&style.procedural;</para>
   <methodsynopsis>
-   <type>bool</type><methodname>finfo_set_flags</methodname>
+   <type>true</type><methodname>finfo_set_flags</methodname>
    <methodparam><type>finfo</type><parameter>finfo</parameter></methodparam>
    <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
@@ -53,7 +53,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success;
+   &return.true.always;
   </para>
  </refsect1>
 

diff --git a/reference/hash/functions/hash-file.xml b/reference/hash/functions/hash-file.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 20dcfbb0dd7150cbe5dfd7903a3001229295c549 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: takagi Status: ready -->
 <!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
 <!-- Credits: mumumu -->
 <refentry xml:id="function.hash-file" xmlns="http://docbook.org/ns/docbook">
@@ -55,7 +55,8 @@
      <listitem>
       <para>
        様々なハッシュアルゴリズム向けの、オプションの配列。
-       現状は、MurmurHash バリアントが "seed" だけをサポートしています。
+       現状は、MurmurHash バリアントが <literal>"seed"</literal>
+       だけをサポートしています。
       </para>
      </listitem>
     </varlistentry>

diff --git a/reference/hash/functions/hash-init.xml b/reference/hash/functions/hash-init.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 20dcfbb0dd7150cbe5dfd7903a3001229295c549 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: takagi Status: ready -->
 <!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
 <!-- Credits: mumumu -->
 <refentry xml:id="function.hash-init" xmlns="http://docbook.org/ns/docbook">
@@ -58,7 +58,8 @@
      <listitem>
       <para>
        様々なハッシュアルゴリズム向けの、オプションの配列。
-       現状は、MurmurHash バリアントが "seed" だけをサポートしています。
+       現状は、MurmurHash バリアントが <literal>"seed"</literal>
+       だけをサポートしています。
       </para>
      </listitem>
     </varlistentry>

diff --git a/reference/hash/functions/hash-pbkdf2.xml b/reference/hash/functions/hash-pbkdf2.xml
@@ -1,10 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 7b68fb17124ccf73ed0c98974d90977a69ea0425 Maintainer: masakielastic Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: masakielastic Status: ready -->
 <!-- Reviewed: no -->
 <!-- Credits: mumumu -->
-
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.hash-pbkdf2">
+<refentry xml:id="function.hash-pbkdf2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>hash_pbkdf2</refname>
   <refpurpose>PBKDF2 を使ってパスワードからキーを生成する</refpurpose>
@@ -20,6 +19,7 @@
    <methodparam><type>int</type><parameter>iterations</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>0</initializer></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>binary</parameter><initializer>&false;</initializer></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
   </methodsynopsis>
  </refsect1>
 
@@ -80,6 +80,16 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry>
+     <term><parameter>options</parameter></term>
+     <listitem>
+      <para>
+       様々なハッシュアルゴリズム向けの、オプションの配列。
+       現状は、MurmurHash バリアントが <literal>"seed"</literal>
+       だけをサポートしています。
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>

diff --git a/reference/hash/functions/hash-update.xml b/reference/hash/functions/hash-update.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: f3e46c7b29574706553f3d892c86aa78ded9e4c0 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: takagi Status: ready -->
 <!-- Credits: mumumu -->
 <refentry xml:id="function.hash-update" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>bool</type><methodname>hash_update</methodname>
+   <type>true</type><methodname>hash_update</methodname>
    <methodparam><type>HashContext</type><parameter>context</parameter></methodparam>
    <methodparam><type>string</type><parameter>data</parameter></methodparam>
   </methodsynopsis>
@@ -43,7 +43,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &true; を返します。
+   &return.true.always;
   </para>
  </refsect1>
 
@@ -84,7 +84,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/hash/functions/hash.xml b/reference/hash/functions/hash.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 20dcfbb0dd7150cbe5dfd7903a3001229295c549 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: takagi Status: ready -->
 <!-- Credits: mumumu -->
 <refentry xml:id="function.hash" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -53,7 +53,8 @@
      <listitem>
       <para>
        様々なハッシュアルゴリズム向けの、オプションの配列。
-       現状は、MurmurHash バリアントが "seed" だけをサポートしています。
+       現状は、MurmurHash バリアントが <literal>"seed"</literal>
+       だけをサポートしています。
       </para>
      </listitem>
     </varlistentry>

diff --git a/reference/ldap/functions/ldap-exop-sync.xml b/reference/ldap/functions/ldap-exop-sync.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: d60af2ee8b4b41f2cff60796275ebf91756455c7 Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: mumumu Status: ready -->
 <refentry xml:id="function.ldap-exop-sync" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ldap_exop_sync</refname>
@@ -13,8 +13,8 @@
    <type class="union"><type>LDAP\Result</type><type>bool</type></type><methodname>ldap_exop_sync</methodname>
    <methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
    <methodparam><type>string</type><parameter>request_oid</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>request_data</parameter><initializer>&null;</initializer></methodparam>
-   <methodparam choice="opt"><type>array</type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>request_data</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type>string</type><parameter role="reference">response_data</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type>string</type><parameter role="reference">response_oid</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>

diff --git a/reference/mbstring/functions/mb-get-info.xml b/reference/mbstring/functions/mb-get-info.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: b5280065f51d028d4a8058619da040f19093f425 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi,mumumu -->
 <refentry xml:id="function.mb-get-info" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -11,7 +11,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type class="union"><type>array</type><type>string</type><type>int</type><type>false</type></type><methodname>mb_get_info</methodname>
+   <type class="union"><type>array</type><type>string</type><type>int</type><type>false</type><type>null</type></type><methodname>mb_get_info</methodname>
    <methodparam choice="opt"><type>string</type><parameter>type</parameter><initializer>"all"</initializer></methodparam>
   </methodsynopsis>
   <simpara>

diff --git a/reference/network/functions/openlog.xml b/reference/network/functions/openlog.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi,mumumu -->
 <refentry xml:id="function.openlog" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -11,7 +11,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>bool</type><methodname>openlog</methodname>
+   <type>true</type><methodname>openlog</methodname>
    <methodparam><type>string</type><parameter>prefix</parameter></methodparam>
    <methodparam><type>int</type><parameter>flags</parameter></methodparam>
    <methodparam><type>int</type><parameter>facility</parameter></methodparam>
@@ -182,10 +182,33 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success;
+   &return.true.always;
   </para>
  </refsect1>
 
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>8.2.0</entry>
+      <entry>
+       この関数は、常に &true; を返すようになりました。
+       これより前のバージョンでは、失敗時に &false; を返していました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>

diff --git a/reference/reflection/reflectionfiber/getexecutingfile.xml b/reference/reflection/reflectionfiber/getexecutingfile.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: ec2fe9a592f794978114ef5021db9f1d00c2e05d Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: mumumu Status: ready -->
 <refentry xml:id="reflectionfiber.getexecutingfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>ReflectionFiber::getExecutingFile</refname>
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="ReflectionFiber">
-   <modifier>public</modifier> <type>string</type><methodname>ReflectionFiber::getExecutingFile</methodname>
+   <modifier>public</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>ReflectionFiber::getExecutingFile</methodname>
    <void/>
   </methodsynopsis>
   <para>
@@ -30,6 +30,8 @@
   &reftitle.returnvalues;
   <para>
    リフレクションされた Fiber が実行しているファイル名のフルパスを返します。
+   リフレクションされた Fiber がユーザー定義関数の外側で使われている場合、
+   &null; を返します。
   </para>
  </refsect1>
 

diff --git a/reference/reflection/reflectionfiber/getexecutingline.xml b/reference/reflection/reflectionfiber/getexecutingline.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: ec2fe9a592f794978114ef5021db9f1d00c2e05d Maintainer: mumumu Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: mumumu Status: ready -->
 <refentry xml:id="reflectionfiber.getexecutingline" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>ReflectionFiber::getExecutingLine</refname>
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis role="ReflectionFiber">
-   <modifier>public</modifier> <type>int</type><methodname>ReflectionFiber::getExecutingLine</methodname>
+   <modifier>public</modifier> <type class="union"><type>int</type><type>null</type></type><methodname>ReflectionFiber::getExecutingLine</methodname>
    <void/>
   </methodsynopsis>
   <para>
@@ -29,6 +29,11 @@
   &reftitle.returnvalues;
   <para>
    Fiber が現在実行している行番号を返します。
+   リフレクションされた <classname>Fiber</classname>
+   が現在実行している行番号を返します。
+   リフレクションされた fiber がユーザー定義関数の外側で実行されている場合、
+   fiber がまだ開始していないか、既に終了している場合、
+   <classname>Error</classname> がスローされます。
   </para>
  </refsect1>
 

diff --git a/reference/sockets/functions/socket-create-listen.xml b/reference/sockets/functions/socket-create-listen.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: a871ef72edf436c59422dedd538594db2541d5f1 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi -->
 <refentry xml:id="function.socket-create-listen" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -13,7 +13,7 @@
   <methodsynopsis>
    <type class="union"><type>Socket</type><type>false</type></type><methodname>socket_create_listen</methodname>
    <methodparam><type>int</type><parameter>port</parameter></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer>128</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>backlog</parameter><initializer><constant>SOMAXCONN</constant></initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>socket_create_listen</function> は、

diff --git a/reference/uodbc/functions/odbc-autocommit.xml b/reference/uodbc/functions/odbc-autocommit.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: a00f64d3cd559177e4ce197acff373646965bf92 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi,mumumu -->
 <refentry xml:id="function.odbc-autocommit" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -12,7 +12,7 @@
   <methodsynopsis>
    <type class="union"><type>int</type><type>bool</type></type><methodname>odbc_autocommit</methodname>
    <methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
-   <methodparam choice="opt"><type>bool</type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
+   <methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    自動コミットの挙動を切り替えます。
@@ -49,13 +49,13 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   <parameter>enable</parameter> パラメータを指定しない場合、
+   <parameter>enable</parameter> パラメータに &null; を指定した場合、
    この関数は、<parameter>odbc</parameter> に関する
    自動コミットの状態を返します。自動コミットがオンの場合に
    非ゼロ、オフの場合にゼロ、エラーを生じた場合に &false; を返します。
   </para>
   <para>
-   <parameter>enable</parameter> が設定されている場合は、
+   <parameter>enable</parameter> が &null; でない値の場合、
    この関数は成功時に &true;、失敗したときに 
    &false; を返します。
   </para>

diff --git a/reference/uodbc/functions/odbc-binmode.xml b/reference/uodbc/functions/odbc-binmode.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: takagi,mumumu -->
 <refentry xml:id="function.odbc-binmode" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>bool</type><methodname>odbc_binmode</methodname>
+   <type>true</type><methodname>odbc_binmode</methodname>
    <methodparam><type>resource</type><parameter>statement</parameter></methodparam>
    <methodparam><type>int</type><parameter>mode</parameter></methodparam>
   </methodsynopsis>
@@ -136,7 +136,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success;
+   &return.true.always;
   </para>
  </refsect1>
 </refentry>

diff --git a/reference/uodbc/functions/odbc-data-source.xml b/reference/uodbc/functions/odbc-data-source.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: db22a7cfcbc3af221f67e228336ac3e2d62aaf2c Maintainer: takagi Status: ready -->
 <!-- Credits: mumumu -->
 <refentry xml:id="function.odbc-data-source" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type class="union"><type>array</type><type>false</type></type><methodname>odbc_data_source</methodname>
+   <type class="union"><type>array</type><type>null</type><type>false</type></type><methodname>odbc_data_source</methodname>
    <methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
    <methodparam><type>int</type><parameter>fetch_type</parameter></methodparam>
   </methodsynopsis>