cvs: phpdoc /en/reference/xdiff/functions xdiff-file-diff-binary.xml xdiff-file-diff.xml xdiff-file-merge3.xml xdiff-file-patch-binary.xml
xdiff-file-patch.xml xdiff-string-diff-binary.xml xdiff-string-diff.xml xdiff-string-merge3.xml xdiff-string-patch-binary.xml xdiff-string-patch.xml
| From: | Mehdi Achour | Date: | Mon, 19 Feb 2007 00:05:05 +0000 |
| Subject: | cvs: phpdoc /en/reference/xdiff/functions xdiff-file-diff-binary.xml xdiff-file-diff.xml xdiff-file-merge3.xml xdiff-file-patch-binary.xml xdiff-file-patch.xml xdiff-string-diff-binary.xml xdiff-string-diff.xml xdiff-string-merge3.xml xdiff-string-patch-binary.xml xdiff-string-patch.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969375520@lists.php.net to get a copy of this message | ||
didou Mon Feb 19 00:05:05 2007 UTC
Modified files:
/phpdoc/en/reference/xdiff/functions xdiff-file-diff-binary.xml
xdiff-file-diff.xml
xdiff-file-merge3.xml
xdiff-file-patch-binary.xml
xdiff-file-patch.xml
xdiff-string-diff-binary.xml
xdiff-string-diff.xml
xdiff-string-merge3.xml
xdiff-string-patch-binary.xml
xdiff-string-patch.xml
Log:
ref.xdiff: switch to new docstyle
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-diff-binary"> <refnamediv> <refname>xdiff_file_diff_binary</refname> <refpurpose>Make binary diff of two files</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_diff_binary</methodname> <methodparam><type>string</type><parameter>file1</parameter></methodparam> @@ -15,19 +16,50 @@ <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_diff_binary</function> makes binary diff of files - <parameter>file1</parameter> and <parameter>file2</parameter> and stores - result in file <parameter>dest</parameter>. This function works with both text - and binary files. Resulting file is in binary format. + Makes a binary diff of two files and stores the result in a file. + This function works with both text and binary files. </para> - <note> - <para> - Both files will be loaded into memory so ensure that your memory_limit is set high enough. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. Resulting file is in binary format. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_diff_binary</function> example</title> @@ -46,10 +78,27 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Both files will be loaded into memory so ensure that your memory_limit is + set high enough. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_diff_binary</function>. + <simplelist> + <member><function>xdiff_string_diff_binary</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml:1.5 phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml:1.6 --- phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml:1.5 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-diff"> <refnamediv> <refname>xdiff_file_diff</refname> <refpurpose>Make unified diff of two files</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_diff</methodname> <methodparam><type>string</type><parameter>file1</parameter></methodparam> @@ -17,23 +18,67 @@ <methodparam choice="opt"><type>bool</type><parameter>minimal</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_diff</function> makes unified diff of files - <parameter>file1</parameter> and <parameter>file2</parameter> and stores - result in file <parameter>dest</parameter>. - <parameter>context</parameter> indicated how many lines of context you - want to include in diff result. Set <parameter>minimal</parameter> to - &true; if you want to minimalize size of diff (can take a long time). - Resulting file is human-readable. + Makes a diff of two files and stores the result in a file. </para> - <note> - <para> - This function doesn't work well with binary files. To make diff of binary - files use <function>xdiff_file_diff_binary</function>. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para> + Indicates how many lines of context you want to include in diff + result. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>minimal</parameter></term> + <listitem> + <para> + Set this parameter to &true; if you want to minimalize size of diff + (can take a long time). Resulting file is human-readable. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_diff</function> example</title> @@ -52,8 +97,24 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function doesn't work well with binary files. To make diff of binary + files use <function>xdiff_file_diff_binary</function>. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_diff</function>. + <simplelist> + <member><function>xdiff_string_diff</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml:1.5 phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml:1.6 --- phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml:1.5 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-merge3"> <refnamediv> <refname>xdiff_file_merge3</refname> <refpurpose>Merge 3 files into one</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>xdiff_file_merge3</methodname> <methodparam><type>string</type><parameter>file1</parameter></methodparam> @@ -16,15 +17,57 @@ <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_merge3</function> merges files - <parameter>file1</parameter>, <parameter>file2</parameter> and - <parameter>file3</parameter> into one and stores result in file - <parameter>dest</parameter>. + Merges three files into one and stores the result in a file. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file3</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns &true; if merge was successful, string with rejected chunks if it was not or &false; if an internal error happened. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_merge3</function> example</title> @@ -48,8 +91,14 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_merge3</function>. + <simplelist> + <member><function>xdiff_string_merge3</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml:1.7 phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml:1.8 --- phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml:1.7 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-patch-binary"> <refnamediv> <refname>xdiff_file_patch_binary</refname> <refpurpose>Patch a file with a binary diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_patch_binary</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> @@ -15,19 +16,52 @@ <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_patch_binary</function> patches file - <parameter>file</parameter> with binary patch in file - <parameter>patch</parameter> and stores result in file - <parameter>dest</parameter>. + Patches a <parameter>file</parameter> with a binary + <parameter>patch</parameter> and stores the result in a file. </para> - <note> - <para> - Both files (file and patch) will be loaded into memory so ensure that your memory_limit is set high enough. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The original file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The binary patch file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_patch_binary</function> example</title> @@ -52,10 +86,28 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Both files (<parameter>file</parameter> and <parameter>patch</parameter>) + will be loaded into memory so ensure that your memory_limit is set high + enough. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_patch_binary</function>. + <simplelist> + <member><function>xdiff_string_patch_binary</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-patch"> <refnamediv> <refname>xdiff_file_patch</refname> <refpurpose>Patch a file with an unified diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>xdiff_file_patch</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> @@ -16,20 +17,63 @@ <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_patch</function> patches file - <parameter>file</parameter> with unified patch in file - <parameter>patch</parameter> and stores result in file - <parameter>dest</parameter>. + Patches a <parameter>file</parameter> with a unified + <parameter>patch</parameter> and stores the result in a file. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>flags</parameter> can be either - <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or - <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch). + <variablelist> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The original file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The patch file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + Can be either <constant>XDIFF_PATCH_NORMAL</constant> (default mode, + normal patch) or <constant>XDIFF_PATCH_REVERSE</constant> (reversed + patch). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns &false; if an internal error happened, string with rejected chunks of patch or &true; if patch has been successfully applied. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_patch</function> example</title> @@ -74,10 +118,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_patch</function>. + <simplelist> + <member><function>xdiff_string_patch</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,29 +1,62 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-diff-binary"> <refnamediv> <refname>xdiff_string_diff_binary</refname> <refpurpose>Make binary diff of two strings</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_diff_binary</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_diff_binary</function> makes binary diff of - strings <parameter>str1</parameter> and <parameter>str2</parameter>. + Makes a binary diff of two strings. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns string with result or &false; if an internal error happened. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_file_diff_binary</function>. + <simplelist> + <member><function>xdiff_file_diff_binary</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-diff"> <refnamediv> <refname>xdiff_string_diff</refname> <refpurpose>Make unified diff of two strings</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_diff</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> @@ -16,21 +17,59 @@ <methodparam choice="opt"><type>bool</type><parameter>minimal</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_diff</function> makes unified diff of strings - <parameter>str1</parameter> and <parameter>str2</parameter>. - <parameter>context</parameter> indicated how many lines of context you - want to include in diff result. Set <parameter>minimal</parameter> to - &true; if you want to minimalize size of diff (can take a long time). + Makes a unified diff of two strings. </para> - <note> - <para> - This function doesn't work well with binary strings. To make diff of binary - strings use <function>xdiff_string_diff_binary</function>. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para> + Indicates how many lines of context you want to include in the diff + result. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>minimal</parameter></term> + <listitem> + <para> + Set this parameter to &true; if you want to minimalize the size of the + diff (can take a long time). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns string with result or &false; if an internal error happened. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_string_diff</function> example</title> @@ -54,8 +93,24 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function doesn't work well with binary strings. To make diff of binary + strings use <function>xdiff_string_diff_binary</function>. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_file_diff</function>. + <simplelist> + <member><function>xdiff_file_diff</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml:1.7 phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml:1.8 --- phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml:1.7 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-merge3"> <refnamediv> <refname>xdiff_string_merge3</refname> <refpurpose>Merge 3 strings into one</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>xdiff_string_merge3</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> @@ -16,22 +17,64 @@ <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_merge3</function> merges strings - <parameter>str1</parameter>, <parameter>str2</parameter> and - <parameter>str3</parameter> into one. + Merges three strings into one. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>error</parameter> is passed then rejected parts are stored - inside this variable. + <variablelist> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str3</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>error</parameter></term> + <listitem> + <para> + If provided then rejected parts are stored inside this variable. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns merged string, &false; if an internal error happened, or &true; if merged string is empty. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_file_merge3</function>. + <simplelist> + <member><function>xdiff_file_merge3</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml:1.3 phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml:1.4 --- phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml:1.3 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,30 +1,64 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-patch-binary"> <refnamediv> <refname>xdiff_string_patch_binary</refname> <refpurpose>Patch a string with a binary diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_patch_binary</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> <methodparam><type>string</type><parameter>patch</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_patch_binary</function> patches string - <parameter>str</parameter> with binary patch in string - <parameter>patch</parameter>. + Patches a string with a binary <parameter>patch</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns a patched string. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The original binary string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The binary patch string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>xdiff_file_patch_binary</function>. + Returns the patched string, or &false; on error. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xdiff_file_patch_binary</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-patch"> <refnamediv> <refname>xdiff_string_patch</refname> <refpurpose>Patch a string with an unified diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_patch</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> @@ -16,19 +17,61 @@ <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_patch</function> patches string - <parameter>str</parameter> with unified patch in string - <parameter>patch</parameter>. + Patches a string with a unified <parameter>patch</parameter> string. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>flags</parameter> can be either - <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or - <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch). + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The original string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The unified patch string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + <parameter>flags</parameter> can be either + <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) + or <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>error</parameter></term> + <listitem> + <para> + If provided then rejected parts are stored inside this variable. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If <parameter>error</parameter> is passed then rejected parts are stored - inside this variable. + Returns the patched string, or &false; on error. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_string_patch</function> example</title> @@ -59,11 +102,14 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Returns a patched string. - </para> - <para> - See also <function>xdiff_file_patch</function>. + <simplelist> + <member><function>xdiff_file_patch</function></member> + </simplelist> </para> </refsect1> </refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-diff-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-diff-binary"> <refnamediv> <refname>xdiff_file_diff_binary</refname> <refpurpose>Make binary diff of two files</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_diff_binary</methodname> <methodparam><type>string</type><parameter>file1</parameter></methodparam> @@ -15,19 +16,50 @@ <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_diff_binary</function> makes binary diff of files - <parameter>file1</parameter> and <parameter>file2</parameter> and stores - result in file <parameter>dest</parameter>. This function works with both text - and binary files. Resulting file is in binary format. + Makes a binary diff of two files and stores the result in a file. + This function works with both text and binary files. </para> - <note> - <para> - Both files will be loaded into memory so ensure that your memory_limit is set high enough. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. Resulting file is in binary format. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_diff_binary</function> example</title> @@ -46,10 +78,27 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Both files will be loaded into memory so ensure that your memory_limit is + set high enough. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_diff_binary</function>. + <simplelist> + <member><function>xdiff_string_diff_binary</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml:1.5 phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml:1.6 --- phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml:1.5 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-diff.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-diff"> <refnamediv> <refname>xdiff_file_diff</refname> <refpurpose>Make unified diff of two files</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_diff</methodname> <methodparam><type>string</type><parameter>file1</parameter></methodparam> @@ -17,23 +18,67 @@ <methodparam choice="opt"><type>bool</type><parameter>minimal</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_diff</function> makes unified diff of files - <parameter>file1</parameter> and <parameter>file2</parameter> and stores - result in file <parameter>dest</parameter>. - <parameter>context</parameter> indicated how many lines of context you - want to include in diff result. Set <parameter>minimal</parameter> to - &true; if you want to minimalize size of diff (can take a long time). - Resulting file is human-readable. + Makes a diff of two files and stores the result in a file. </para> - <note> - <para> - This function doesn't work well with binary files. To make diff of binary - files use <function>xdiff_file_diff_binary</function>. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para> + Indicates how many lines of context you want to include in diff + result. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>minimal</parameter></term> + <listitem> + <para> + Set this parameter to &true; if you want to minimalize size of diff + (can take a long time). Resulting file is human-readable. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_diff</function> example</title> @@ -52,8 +97,24 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function doesn't work well with binary files. To make diff of binary + files use <function>xdiff_file_diff_binary</function>. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_diff</function>. + <simplelist> + <member><function>xdiff_string_diff</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml:1.5 phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml:1.6 --- phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml:1.5 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-merge3.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-merge3"> <refnamediv> <refname>xdiff_file_merge3</refname> <refpurpose>Merge 3 files into one</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>xdiff_file_merge3</methodname> <methodparam><type>string</type><parameter>file1</parameter></methodparam> @@ -16,15 +17,57 @@ <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_merge3</function> merges files - <parameter>file1</parameter>, <parameter>file2</parameter> and - <parameter>file3</parameter> into one and stores result in file - <parameter>dest</parameter>. + Merges three files into one and stores the result in a file. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>file3</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns &true; if merge was successful, string with rejected chunks if it was not or &false; if an internal error happened. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_merge3</function> example</title> @@ -48,8 +91,14 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_merge3</function>. + <simplelist> + <member><function>xdiff_string_merge3</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml:1.7 phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml:1.8 --- phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml:1.7 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-patch-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-patch-binary"> <refnamediv> <refname>xdiff_file_patch_binary</refname> <refpurpose>Patch a file with a binary diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>xdiff_file_patch_binary</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> @@ -15,19 +16,52 @@ <methodparam><type>string</type><parameter>dest</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_patch_binary</function> patches file - <parameter>file</parameter> with binary patch in file - <parameter>patch</parameter> and stores result in file - <parameter>dest</parameter>. + Patches a <parameter>file</parameter> with a binary + <parameter>patch</parameter> and stores the result in a file. </para> - <note> - <para> - Both files (file and patch) will be loaded into memory so ensure that your memory_limit is set high enough. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The original file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The binary patch file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_patch_binary</function> example</title> @@ -52,10 +86,28 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Both files (<parameter>file</parameter> and <parameter>patch</parameter>) + will be loaded into memory so ensure that your memory_limit is set high + enough. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_patch_binary</function>. + <simplelist> + <member><function>xdiff_string_patch_binary</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-file-patch.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-file-patch"> <refnamediv> <refname>xdiff_file_patch</refname> <refpurpose>Patch a file with an unified diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>xdiff_file_patch</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> @@ -16,20 +17,63 @@ <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_file_patch</function> patches file - <parameter>file</parameter> with unified patch in file - <parameter>patch</parameter> and stores result in file - <parameter>dest</parameter>. + Patches a <parameter>file</parameter> with a unified + <parameter>patch</parameter> and stores the result in a file. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>flags</parameter> can be either - <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or - <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch). + <variablelist> + <varlistentry> + <term><parameter>file</parameter></term> + <listitem> + <para> + The original file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The patch file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dest</parameter></term> + <listitem> + <para> + Path of the resulting file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + Can be either <constant>XDIFF_PATCH_NORMAL</constant> (default mode, + normal patch) or <constant>XDIFF_PATCH_REVERSE</constant> (reversed + patch). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns &false; if an internal error happened, string with rejected chunks of patch or &true; if patch has been successfully applied. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_file_patch</function> example</title> @@ -74,10 +118,17 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_string_patch</function>. + <simplelist> + <member><function>xdiff_string_patch</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-diff-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,29 +1,62 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-diff-binary"> <refnamediv> <refname>xdiff_string_diff_binary</refname> <refpurpose>Make binary diff of two strings</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_diff_binary</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> <methodparam><type>string</type><parameter>str2</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_diff_binary</function> makes binary diff of - strings <parameter>str1</parameter> and <parameter>str2</parameter>. + Makes a binary diff of two strings. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns string with result or &false; if an internal error happened. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_file_diff_binary</function>. + <simplelist> + <member><function>xdiff_file_diff_binary</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-diff.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-diff"> <refnamediv> <refname>xdiff_string_diff</refname> <refpurpose>Make unified diff of two strings</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_diff</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> @@ -16,21 +17,59 @@ <methodparam choice="opt"><type>bool</type><parameter>minimal</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_diff</function> makes unified diff of strings - <parameter>str1</parameter> and <parameter>str2</parameter>. - <parameter>context</parameter> indicated how many lines of context you - want to include in diff result. Set <parameter>minimal</parameter> to - &true; if you want to minimalize size of diff (can take a long time). + Makes a unified diff of two strings. </para> - <note> - <para> - This function doesn't work well with binary strings. To make diff of binary - strings use <function>xdiff_string_diff_binary</function>. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>context</parameter></term> + <listitem> + <para> + Indicates how many lines of context you want to include in the diff + result. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>minimal</parameter></term> + <listitem> + <para> + Set this parameter to &true; if you want to minimalize the size of the + diff (can take a long time). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns string with result or &false; if an internal error happened. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_string_diff</function> example</title> @@ -54,8 +93,24 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + This function doesn't work well with binary strings. To make diff of binary + strings use <function>xdiff_string_diff_binary</function>. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_file_diff</function>. + <simplelist> + <member><function>xdiff_file_diff</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml:1.7 phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml:1.8 --- phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml:1.7 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-merge3.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-merge3"> <refnamediv> <refname>xdiff_string_merge3</refname> <refpurpose>Merge 3 strings into one</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>xdiff_string_merge3</methodname> <methodparam><type>string</type><parameter>str1</parameter></methodparam> @@ -16,22 +17,64 @@ <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_merge3</function> merges strings - <parameter>str1</parameter>, <parameter>str2</parameter> and - <parameter>str3</parameter> into one. + Merges three strings into one. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - If <parameter>error</parameter> is passed then rejected parts are stored - inside this variable. + <variablelist> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str3</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>error</parameter></term> + <listitem> + <para> + If provided then rejected parts are stored inside this variable. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Returns merged string, &false; if an internal error happened, or &true; if merged string is empty. </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>xdiff_file_merge3</function>. + <simplelist> + <member><function>xdiff_file_merge3</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml:1.3 phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml:1.4 --- phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml:1.3 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-patch-binary.xml Mon Feb 19 00:05:05 2007 @@ -1,30 +1,64 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-patch-binary"> <refnamediv> <refname>xdiff_string_patch_binary</refname> <refpurpose>Patch a string with a binary diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_patch_binary</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> <methodparam><type>string</type><parameter>patch</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_patch_binary</function> patches string - <parameter>str</parameter> with binary patch in string - <parameter>patch</parameter>. + Patches a string with a binary <parameter>patch</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Returns a patched string. + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The original binary string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The binary patch string. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>xdiff_file_patch_binary</function>. + Returns the patched string, or &false; on error. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>xdiff_file_patch_binary</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml diff -u phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml:1.6 phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml:1.7 --- phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml:1.6 Mon Feb 19 00:04:48 2007 +++ phpdoc/en/reference/xdiff/functions/xdiff-string-patch.xml Mon Feb 19 00:05:05 2007 @@ -1,13 +1,14 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. --> <refentry id="function.xdiff-string-patch"> <refnamediv> <refname>xdiff_string_patch</refname> <refpurpose>Patch a string with an unified diff</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>xdiff_string_patch</methodname> <methodparam><type>string</type><parameter>str</parameter></methodparam> @@ -16,19 +17,61 @@ <methodparam choice="opt"><type>string</type><parameter role="reference">error</parameter></methodparam> </methodsynopsis> <para> - <function>xdiff_string_patch</function> patches string - <parameter>str</parameter> with unified patch in string - <parameter>patch</parameter>. + Patches a string with a unified <parameter>patch</parameter> string. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <parameter>flags</parameter> can be either - <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) or - <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch). + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem> + <para> + The original string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>patch</parameter></term> + <listitem> + <para> + The unified patch string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + <parameter>flags</parameter> can be either + <constant>XDIFF_PATCH_NORMAL</constant> (default mode, normal patch) + or <constant>XDIFF_PATCH_REVERSE</constant> (reversed patch). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>error</parameter></term> + <listitem> + <para> + If provided then rejected parts are stored inside this variable. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If <parameter>error</parameter> is passed then rejected parts are stored - inside this variable. + Returns the patched string, or &false; on error. </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title><function>xdiff_string_patch</function> example</title> @@ -59,11 +102,14 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - Returns a patched string. - </para> - <para> - See also <function>xdiff_file_patch</function>. + <simplelist> + <member><function>xdiff_file_patch</function></member> + </simplelist> </para> </refsect1> </refentry>