svn: /phpdoc/ja/trunk/reference/bzip2/functions/ bzcompress.xml bzdecompress.xml bzopen.xml bzread.xml bzwrite.xml

[email protected] (Yoshinari Takaoka)
Newsgroups php.doc.ja
Message-ID <[email protected]> 
mumumu                                   Tue, 24 Nov 2020 23:14:59 +0000

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

Log:
Generate bz2 methodsynopses based on stubs

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

Changed paths:
    U   phpdoc/ja/trunk/reference/bzip2/functions/bzcompress.xml
    U   phpdoc/ja/trunk/reference/bzip2/functions/bzdecompress.xml
    U   phpdoc/ja/trunk/reference/bzip2/functions/bzopen.xml
    U   phpdoc/ja/trunk/reference/bzip2/functions/bzread.xml
    U   phpdoc/ja/trunk/reference/bzip2/functions/bzwrite.xml
svn-diffs-351612.txt (text/x-diff, 11.6 KB) 
Modified: phpdoc/ja/trunk/reference/bzip2/functions/bzcompress.xml
===================================================================
--- phpdoc/ja/trunk/reference/bzip2/functions/bzcompress.xml	2020-11-24 23:07:05 UTC (rev 351611)
+++ phpdoc/ja/trunk/reference/bzip2/functions/bzcompress.xml	2020-11-24 23:14:59 UTC (rev 351612)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 313913 Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: shimooka -->
+<!-- EN-Revision: 351552 Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: shimooka,mumumu -->
 <refentry xml:id="function.bzcompress" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>bzcompress</refname>
@@ -10,10 +10,10 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>bzcompress</methodname>
-   <methodparam><type>string</type><parameter>source</parameter></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>blocksize</parameter><initializer>4</initializer></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>workfactor</parameter><initializer>0</initializer></methodparam>
+   <type class="union"><type>string</type><type>int</type></type><methodname>bzcompress</methodname>
+   <methodparam><type>string</type><parameter>data</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>block_size</parameter><initializer>4</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>work_factor</parameter><initializer>0</initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>bzcompress</function> は、与えられた文字列を圧縮し、
@@ -25,7 +25,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>source</parameter></term>
+     <term><parameter>data</parameter></term>
      <listitem>
       <para>
        圧縮する文字列
@@ -33,7 +33,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>blocksize</parameter></term>
+     <term><parameter>block_size</parameter></term>
      <listitem>
       <para>
        圧縮時のブロック長を指定します。
@@ -43,7 +43,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>workfactor</parameter></term>
+     <term><parameter>work_factor</parameter></term>
      <listitem>
       <para>
        繰り返しが多い、最悪の入力データの場合の圧縮処理の動作を制御します。
@@ -50,7 +50,7 @@
        この値は、0 から 250 までとなり、0 は特別な場合です。
       </para>
       <para>
-       <parameter>workfactor</parameter> によらず、
+       <parameter>work_factor</parameter> によらず、
        生成される出力は同じになります。
       </para>
      </listitem>
@@ -88,7 +88,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/bzip2/functions/bzdecompress.xml
===================================================================
--- phpdoc/ja/trunk/reference/bzip2/functions/bzdecompress.xml	2020-11-24 23:07:05 UTC (rev 351611)
+++ phpdoc/ja/trunk/reference/bzip2/functions/bzdecompress.xml	2020-11-24 23:14:59 UTC (rev 351612)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 313913 Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: shimooka -->
+<!-- EN-Revision: 351552 Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: shimooka,mumumu -->
 <refentry xml:id="function.bzdecompress" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>bzdecompress</refname>
@@ -10,9 +10,9 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>mixed</type><methodname>bzdecompress</methodname>
-   <methodparam><type>string</type><parameter>source</parameter></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>small</parameter><initializer>0</initializer></methodparam>
+   <type class="union"><type>string</type><type>int</type><type>false</type></type><methodname>bzdecompress</methodname>
+   <methodparam><type>string</type><parameter>data</parameter></methodparam>
+   <methodparam choice="opt"><type>bool</type><parameter>use_less_memory</parameter><initializer>&false;</initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>bzdecompress</function> は、bzip2
@@ -24,7 +24,7 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter>source</parameter></term>
+     <term><parameter>data</parameter></term>
      <listitem>
       <para>
        解凍する文字列
@@ -32,7 +32,7 @@
      </listitem>
     </varlistentry>
     <varlistentry>
-     <term><parameter>small</parameter></term>
+     <term><parameter>use_less_memory</parameter></term>
      <listitem>
       <para>
        &true; の場合、よりメモリの消
@@ -51,9 +51,36 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   解凍された文字列列、もしくはエラー時はエラー数
+   解凍された文字列、もしくは or &false;。
+   エラー時はエラー数を返します。
   </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.0.0</entry>
+      <entry>
+       <parameter>use_less_memory</parameter> の型は
+       <type>int</type> から <type>bool</type> に変更されました。
+       これより前のバージョンでは、
+       デフォルト値は <literal>0</literal> でした。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -88,7 +115,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/bzip2/functions/bzopen.xml
===================================================================
--- phpdoc/ja/trunk/reference/bzip2/functions/bzopen.xml	2020-11-24 23:07:05 UTC (rev 351611)
+++ phpdoc/ja/trunk/reference/bzip2/functions/bzopen.xml	2020-11-24 23:14:59 UTC (rev 351612)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 336899 Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: shimooka -->
+<!-- EN-Revision: 351552 Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: shimooka,mumumu -->
 <refentry xml:id="function.bzopen" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>bzopen</refname>
@@ -10,13 +10,13 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>resource</type><methodname>bzopen</methodname>
-   <methodparam><type>mixed</type><parameter>file</parameter></methodparam>
+   <type class="union"><type>resource</type><type>false</type></type><methodname>bzopen</methodname>
+   <methodparam><type class="union"><type>string</type><type>resource</type></type><parameter>file</parameter></methodparam>
    <methodparam><type>string</type><parameter>mode</parameter></methodparam>
   </methodsynopsis>
   <para>
    <function>bzopen</function> は、
-   bzip2 (.bz2) ファイルを読み書き用にオープンします。
+   bzip2 (<filename>.bz2</filename>) ファイルを読み書き用にオープンします。
   </para>
  </refsect1>
  <refsect1 role="parameters">
@@ -35,7 +35,7 @@
      <term><parameter>mode</parameter></term>
      <listitem>
       <para>
-       'r' (読み込み) と 'w' (書き込み) だけをサポートしています。
+       <literal>'r'</literal> (読み込み) と <literal>'w'</literal> (書き込み) だけをサポートしています。
        それ以外を指定すると <function>bzopen</function> は &false; を返します。
       </para>
      </listitem>
@@ -80,7 +80,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/bzip2/functions/bzread.xml
===================================================================
--- phpdoc/ja/trunk/reference/bzip2/functions/bzread.xml	2020-11-24 23:07:05 UTC (rev 351611)
+++ phpdoc/ja/trunk/reference/bzip2/functions/bzread.xml	2020-11-24 23:14:59 UTC (rev 351612)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 308599 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 351552 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: shimooka -->
 <refentry xml:id="function.bzread" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>bzread</methodname>
+   <type class="union"><type>string</type><type>false</type></type><methodname>bzread</methodname>
    <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1024</initializer></methodparam>
   </methodsynopsis>
@@ -94,7 +94,6 @@
   </para>
  </refsect1>
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

Modified: phpdoc/ja/trunk/reference/bzip2/functions/bzwrite.xml
===================================================================
--- phpdoc/ja/trunk/reference/bzip2/functions/bzwrite.xml	2020-11-24 23:07:05 UTC (rev 351611)
+++ phpdoc/ja/trunk/reference/bzip2/functions/bzwrite.xml	2020-11-24 23:14:59 UTC (rev 351612)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 297028 Maintainer: hirokawa Status: ready -->
-<!-- CREDITS: shimooka -->
+<!-- EN-Revision: 351552 Maintainer: hirokawa Status: ready -->
+<!-- CREDITS: shimooka,mumumu -->
 <refentry xml:id="function.bzwrite" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>bzwrite</refname>
@@ -10,10 +10,10 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>int</type><methodname>bzwrite</methodname>
+   <type class="union"><type>int</type><type>false</type></type><methodname>bzwrite</methodname>
    <methodparam><type>resource</type><parameter>bz</parameter></methodparam>
    <methodparam><type>string</type><parameter>data</parameter></methodparam>
-   <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
+   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
   <para>
    <function>bzwrite</function> は、文字列を与えられた bzip2
@@ -61,6 +61,29 @@
    書き込んだバイト数、もしくはエラー時に &false; を返します。
   </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.0.0</entry>
+      <entry>
+       <parameter>length</parameter> は、nullable になりました。
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -89,7 +112,6 @@
   </para>
  </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.