Hi mazz,

The patches look good, but we should adopt the new docskel for newly 
documented functions.

Docskel is here; http://wiki.phpdoc.info/DocSkel

The last one I converted was: http://livedocs.homelinux.com/mysql_query

> +      The GD2 format is commonly used to allow fast loading of parts of 
> images.
> +      Note that the GD2 format is only usable in GD2-compatible 
> applications.

I find this a bit ambigous, what does it mean for the end user?

Good work,
Aidan


"Mazzanet" <[EMAIL PROTECTED]> wrote in message 
news:[EMAIL PROTECTED]
> Attached are some patches for the manual pages of imagegd and imagegd2.
>
>
> Matt
>


--------------------------------------------------------------------------------


> Index: imagegd.xml
> ===================================================================
> RCS file: /repository/phpdoc/en/reference/image/functions/imagegd.xml,v
> retrieving revision 1.4
> diff -u -r1.4 imagegd.xml
> --- imagegd.xml 21 Jun 2004 11:45:37 -0000 1.4
> +++ imagegd.xml 19 Jan 2005 10:40:25 -0000
> @@ -14,7 +14,23 @@
>       <methodparam 
> choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
>      </methodsynopsis>
>     <para>
> -     &warn.undocumented.func;
> +     <function>imagegd</function> outputs a GD image to
> +     <parameter>filename</parameter>. The <parameter>image</parameter>
> +     argument is the return from the <function>imagecreate</function>
> +     function.
> +    </para>
> +    <para>
> +     The <parameter>filename</parameter> parameter is optional, and if 
> left
> +     off, the raw image stream will be output directly.
> +    </para>
> +    <note>
> +     <para>
> +      The GD format is commonly used to allow fast loading of parts of 
> images.
> +      Note that the GD format is only usable in GD-compatible 
> applications.
> +     </para>
> +    </note>
> +    <para>
> +     See also <function>imagegd2</function>.
>     </para>
>    </refsect1>
>   </refentry>
>


--------------------------------------------------------------------------------


> Index: imagegd2.xml
> ===================================================================
> RCS file: /repository/phpdoc/en/reference/image/functions/imagegd2.xml,v
> retrieving revision 1.10
> diff -u -r1.10 imagegd2.xml
> --- imagegd2.xml 21 Jun 2004 11:45:37 -0000 1.10
> +++ imagegd2.xml 19 Jan 2005 10:40:52 -0000
> @@ -4,7 +4,7 @@
>   <refentry id='function.imagegd2'>
>    <refnamediv>
>     <refname>imagegd2</refname>
> -    <refpurpose>Output GD2 image</refpurpose>
> +    <refpurpose>Output GD2 image to browser or file</refpurpose>
>    </refnamediv>
>    <refsect1>
>     <title>Description</title>
> @@ -16,7 +16,14 @@
>       <methodparam 
> choice="opt"><type>int</type><parameter>type</parameter></methodparam>
>      </methodsynopsis>
>     <para>
> -     <function>imagegd2</function> outputs GD2 image to browser or file.
> +     <function>imagegd2</function> outputs a GD2 image to
> +     <parameter>filename</parameter>.
> +     The <parameter>image</parameter> parameter is the return from the
> +     <function>imagecreate</function> function.
> +    </para>
> +    <para>
> +     The <parameter>filename</parameter> parameter is optional, and if 
> left
> +     off, the raw image stream will be output directly.
>     </para>
>     <para>
>      The optional <parameter>type</parameter> parameter is either
> @@ -30,6 +37,15 @@
>       in PHP 4.3.2.
>      </para>
>     </note>
> +    <note>
> +     <para>
> +      The GD2 format is commonly used to allow fast loading of parts of 
> images.
> +      Note that the GD2 format is only usable in GD2-compatible 
> applications.
> +     </para>
> +    </note>
> +    <para>
> +     See also <function>imagegd</function>
> +    </para>
>    </refsect1>
>   </refentry>
>
> 

Reply via email to