From 85bdebe1e43eef256789b2d07a2a12654253fe51 Mon Sep 17 00:00:00 2001
From: Kalle Sommer Nielsen <kalle@php.net>
Date: Wed, 30 Jul 2008 03:05:34 +0000
Subject: [PATCH] Fix various bugs inside gd documentation part 1/3

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@263821 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/image/functions/image2wbmp.xml        |  3 ++-
 reference/image/functions/imagecolormatch.xml   |  8 ++++----
 .../image/functions/imagecolorsforindex.xml     |  3 ++-
 reference/image/functions/imageconvolution.xml  |  3 ++-
 reference/image/functions/imagecreatefromgd.xml | 11 +++++++++--
 .../image/functions/imagecreatefromgd2.xml      | 13 +++++++++++--
 .../image/functions/imagecreatefromgd2part.xml  | 17 +++++++++++++++--
 .../image/functions/imagecreatefromgif.xml      |  4 ++--
 .../image/functions/imagecreatefrompng.xml      |  4 ++--
 .../image/functions/imagecreatefromxpm.xml      |  4 ++--
 10 files changed, 51 insertions(+), 19 deletions(-)

diff --git a/reference/image/functions/image2wbmp.xml b/reference/image/functions/image2wbmp.xml
index 029d5e24f5..f950758e00 100644
--- a/reference/image/functions/image2wbmp.xml
+++ b/reference/image/functions/image2wbmp.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <refentry xml:id="function.image2wbmp" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>image2wbmp</refname>
@@ -36,6 +36,7 @@
      <term><parameter>threshold</parameter></term>
      <listitem>
       <para>
+       Threshold value, between 0 and 255 (inclusive)
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/image/functions/imagecolormatch.xml b/reference/image/functions/imagecolormatch.xml
index 9289c985ff..6cd4758dda 100644
--- a/reference/image/functions/imagecolormatch.xml
+++ b/reference/image/functions/imagecolormatch.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry xml:id="function.imagecolormatch" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecolormatch</refname>
@@ -12,9 +12,9 @@
    <methodparam><type>resource</type><parameter>image1</parameter></methodparam>
    <methodparam><type>resource</type><parameter>image2</parameter></methodparam>
   </methodsynopsis>
-
-  &warn.undocumented.func;
-
+  <para>
+   Makes the colors of the palette version of an image more closely match the true color version
+  </para>
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
diff --git a/reference/image/functions/imagecolorsforindex.xml b/reference/image/functions/imagecolorsforindex.xml
index 20d24101fe..0a08a7c8b1 100644
--- a/reference/image/functions/imagecolorsforindex.xml
+++ b/reference/image/functions/imagecolorsforindex.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry xml:id="function.imagecolorsforindex" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecolorsforindex</refname>
@@ -25,6 +25,7 @@
      <term><parameter>index</parameter></term>
      <listitem>
       <para>
+       The color index
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/image/functions/imageconvolution.xml b/reference/image/functions/imageconvolution.xml
index 08acfc7c16..bba682598b 100644
--- a/reference/image/functions/imageconvolution.xml
+++ b/reference/image/functions/imageconvolution.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry xml:id="function.imageconvolution" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imageconvolution</refname>
@@ -44,6 +44,7 @@
      <term><parameter>offset</parameter></term>
      <listitem>
       <para>
+       Color offset
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/image/functions/imagecreatefromgd.xml b/reference/image/functions/imagecreatefromgd.xml
index 8de42cfa59..35c5b14397 100644
--- a/reference/image/functions/imagecreatefromgd.xml
+++ b/reference/image/functions/imagecreatefromgd.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry xml:id='function.imagecreatefromgd' xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecreatefromgd</refname>
@@ -12,7 +12,7 @@
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
   <para>
-   &warn.undocumented.func;
+   Create a new image from GD file or URL
   </para>
   &tip.fopen-wrapper;
  </refsect1>
@@ -24,12 +24,19 @@
      <term><parameter>filename</parameter></term>
      <listitem>
       <para>
+       Path to the GD file
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an image resource identifier on success, &false; on errors.
+  </para>
+ </refsect1>
  <refsect1 role="notes">
   &reftitle.notes;
   &warn.no-win32-fopen-wrapper;
diff --git a/reference/image/functions/imagecreatefromgd2.xml b/reference/image/functions/imagecreatefromgd2.xml
index bebb2f40e2..6289aee9fd 100644
--- a/reference/image/functions/imagecreatefromgd2.xml
+++ b/reference/image/functions/imagecreatefromgd2.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <refentry xml:id='function.imagecreatefromgd2' xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecreatefromgd2</refname>
@@ -11,7 +11,9 @@
    <type>resource</type><methodname>imagecreatefromgd2</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
-  &warn.undocumented.func;
+  <para>
+   Create a new image from GD2 file or URL
+  </para>
   &tip.fopen-wrapper;
  </refsect1>
  <refsect1 role="parameters">
@@ -22,12 +24,19 @@
      <term><parameter>filename</parameter></term>
      <listitem>
       <para>
+       Path to the GD2 image
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an image resource identifier on success, &false; on errors.
+  </para>
+ </refsect1>
  <refsect1 role="notes">
   &reftitle.notes;
   &note.gd.2;
diff --git a/reference/image/functions/imagecreatefromgd2part.xml b/reference/image/functions/imagecreatefromgd2part.xml
index 54af8f4eb7..a7c6c6e072 100644
--- a/reference/image/functions/imagecreatefromgd2part.xml
+++ b/reference/image/functions/imagecreatefromgd2part.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
 <refentry xml:id='function.imagecreatefromgd2part' xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecreatefromgd2part</refname>
@@ -15,7 +15,9 @@
    <methodparam><type>int</type><parameter>width</parameter></methodparam>
    <methodparam><type>int</type><parameter>height</parameter></methodparam>
   </methodsynopsis>
-  &warn.undocumented.func;
+  <para>
+   Create a new image from a given part of GD2 file or URL
+  </para>
   &tip.fopen-wrapper;
  </refsect1>
  <refsect1 role="parameters">
@@ -26,6 +28,7 @@
      <term><parameter>filename</parameter></term>
      <listitem>
       <para>
+       Path to the GD2 image
       </para>
      </listitem>
     </varlistentry>
@@ -33,6 +36,7 @@
      <term><parameter>srcX</parameter></term>
      <listitem>
       <para>
+       x-coordinate of source point
       </para>
      </listitem>
     </varlistentry>
@@ -40,6 +44,7 @@
      <term><parameter>srcY</parameter></term>
      <listitem>
       <para>
+       y-coordinate of source point
       </para>
      </listitem>
     </varlistentry>
@@ -47,6 +52,7 @@
      <term><parameter>width</parameter></term>
      <listitem>
       <para>
+       Source width
       </para>
      </listitem>
     </varlistentry>
@@ -54,12 +60,19 @@
      <term><parameter>height</parameter></term>
      <listitem>
       <para>
+       Source height
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an image resource identifier on success, &false; on errors.
+  </para>
+ </refsect1>
  <refsect1 role="notes">
   &reftitle.notes;
   &note.gd.2;
diff --git a/reference/image/functions/imagecreatefromgif.xml b/reference/image/functions/imagecreatefromgif.xml
index e225c887eb..ec6ca14082 100644
--- a/reference/image/functions/imagecreatefromgif.xml
+++ b/reference/image/functions/imagecreatefromgif.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.18 $ -->
+<!-- $Revision: 1.19 $ -->
 <refentry xml:id="function.imagecreatefromgif" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecreatefromgif</refname>
@@ -44,7 +44,7 @@ imagegif($img);
     &example.outputs.similar;
     <mediaobject>
      <imageobject>
-      <imagedata fileref="figures/image.imagefromgif.png"/>
+      <imagedata fileref="figures/image.imagecreatefromgif.gif"/>
      </imageobject>
     </mediaobject>
    </example>
diff --git a/reference/image/functions/imagecreatefrompng.xml b/reference/image/functions/imagecreatefrompng.xml
index a898889abd..82367c96b4 100644
--- a/reference/image/functions/imagecreatefrompng.xml
+++ b/reference/image/functions/imagecreatefrompng.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.14 $ -->
+<!-- $Revision: 1.15 $ -->
 <refentry xml:id="function.imagecreatefrompng" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecreatefrompng</refname>
@@ -47,7 +47,7 @@ imagepng($img);
     &example.outputs.similar;
     <mediaobject>
      <imageobject>
-      <imagedata fileref="figures/image.imagecreatefrompng.png"/>
+      <imagedata fileref="figures/image.imagecreatefrompng.gif"/>
      </imageobject>
     </mediaobject>
    </example>
diff --git a/reference/image/functions/imagecreatefromxpm.xml b/reference/image/functions/imagecreatefromxpm.xml
index a42d26589d..c8b69463f8 100644
--- a/reference/image/functions/imagecreatefromxpm.xml
+++ b/reference/image/functions/imagecreatefromxpm.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry xml:id="function.imagecreatefromxpm" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>imagecreatefromxpm</refname>
@@ -41,7 +41,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   &note.bundled.gd;
-  &warn.no-win32-fopen-wrapper;
+  &note.no-windows;
  </refsect1>
 </refentry>