Fix incorrect function name and description for xdiff_string_rabdiff() / Fix union type tagging for xdiff_string_rabdiff()

php/doc-en@1987020
php/doc-en@480cc8a

Author: mumumu

reference/xdiff/functions/xdiff-string-rabdiff.xml

@@ -1,33 +1,40 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: takagi Status: ready -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- EN-Revision: 480cc8a9efdb0d2cb1a12bc5c3bab80875a099ee Maintainer: takagi Status: ready -->
 <refentry xml:id="function.xdiff-string-rabdiff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>xdiff_string_rabdiff</refname>
-  <refpurpose>2 つの文字列のバイナリ diff を、Rabin の polynomial fingerprinting アルゴリズムで作成する</refpurpose>
+  <refpurpose>
+   2 つの文字列のバイナリ diff を、Rabin の polynomial fingerprinting アルゴリズムで作成する
+  </refpurpose>
  </refnamediv>
- 
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>xdiff_string_bdiff</methodname>
+   <type class="union"><type>string</type><type>false</type></type><methodname>xdiff_string_rabdiff</methodname>
    <methodparam><type>string</type><parameter>old_data</parameter></methodparam>
    <methodparam><type>string</type><parameter>new_data</parameter></methodparam>
   </methodsynopsis>
   <para>
-   ふたつの文字列のバイナリ diff を作成して結果を返します。
+   ふたつの文字列のバイナリ diff を生成します。
+   <link xlink:href="&url.xdiff;">libxdiff</link>
+   によって実装された Rabin の polynomial fingerprinting
+   アルゴリズムを使用します。
    この関数と <function>xdiff_string_bdiff</function> との違いは、
-   使用するアルゴリズムです。この関数のほうが実行速度が速く、より小さな diff を生成します。
+   使用するアルゴリズムです。この関数のほうが実行速度が速く、
+   より小さな diff を生成します。
+   また、パッチを適用する際に用いる <function>xdiff_string_bpatch</function> や
+   <function>xdiff_file_bpatch</function> と完全な互換性があります。
+  </para>
+  <para>
    この関数はテキストファイルとバイナリファイルの両方に適用可能です。
-   できあがったパッチファイルを後で適用するには
-   <function>xdiff_string_bpatch</function>/<function>xdiff_file_bpatch</function>
-   を使用します。
+   生成された diff データは後に適用することで、
+   古いバージョンから新しいバージョンを再構築できます。
   </para>
   <para>
-   アルゴリズムの違いについての詳細は、
-   <link xlink:href="&url.xdiff;">libxdiff</link>
-   のウェブサイトを参照ください。
+   アルゴリズムの詳細は、
+   <link xlink:href="https://www.xmailserver.org/xdiff-lib.html">libxdiff documentation</link> を参照ください。
   </para>
  </refsect1>
 
@@ -39,15 +46,15 @@
      <term><parameter>old_data</parameter></term>
      <listitem>
       <para>
-       バイナリデータを含む最初の文字列。"旧" データです。
+       "旧" バイナリデータを含む最初の文字列
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><parameter>new_data</parameter></term>
      <listitem>
       <para>
-       バイナリデータを含む 2 番目の文字列。"新" データです。
+       "新" バイナリデータを含む 2 番目の文字列
       </para>
      </listitem>
     </varlistentry>
@@ -58,22 +65,43 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   "旧" データと "新" データの差分を含むバイナリ diff 文字列、
-   あるいは内部エラーが発生した場合は &false; を返します。
+   "旧" データと "新" データの差分を含むバイナリ diff 文字列を返します。
+   &return.falseforfailure;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>2つの文字列間のバイナリ diff を作成する</title>
+    <programlisting role="php">
+     <![CDATA[
+<?php
+$old = file_get_contents('file_v1.txt');
+$new = file_get_contents('file_v2.txt');
+
+$diff = xdiff_string_rabdiff($old, $new);
+file_put_contents('patch.rdiff', $diff);
+?>
+]]>
+    </programlisting>
+   </example>
   </para>
  </refsect1>
 
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
+    <member><function>xdiff_string_bdiff</function></member>
     <member><function>xdiff_string_bpatch</function></member>
+    <member><function>xdiff_file_bpatch</function></member>
    </simplelist>
   </para>
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml