- added missing documentation for some functions

- put a note on some deprecated functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@31540 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Uwe Steinmann 2000-08-30 16:21:24 +00:00
parent bac76ed3d7
commit d2a6c34e2e

View file

@ -811,6 +811,54 @@ pdf_close($pdfdoc);
</refsect1>
</refentry>
<refentry id="function.pdf-get-image-height">
<refnamediv>
<refname>PDF_get_image_height</refname>
<refpurpose>Returns height of an image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>pdf_get_image_height</function></funcdef>
<paramdef>int <parameter>pdf document</parameter></paramdef>
<paramdef>int <parameter>image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
The <function>PDF_get_image_height</function> function returns the
heights of a pdf image in pixel.</para>
<para>
See also <function>PDF_open_image_file</function>,
<function>PDF_open_memory_image</function>,
<function>PDF_get_image_width</function>.</para>
</refsect1>
</refentry>
<refentry id="function.pdf-get-image-width">
<refnamediv>
<refname>PDF_get_image_width</refname>
<refpurpose>Returns width of an image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>pdf_get_image_width</function></funcdef>
<paramdef>int <parameter>pdf document</parameter></paramdef>
<paramdef>int <parameter>image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
The <function>PDF_get_image_width</function> function returns the
widths of a pdf image in pixel.</para>
<para>
See also <function>PDF_open_image_file</function>,
<function>PDF_open_memory_image</function>,
<function>PDF_get_image_height</function>.</para>
</refsect1>
</refentry>
<refentry id="function.pdf-set-text-rendering">
<refnamediv>
<refname>PDF_set_text_rendering</refname>
@ -1988,6 +2036,9 @@ PDF_stroke($pdf);
in the file with the name <parameter>filename</parameter>.
The format of the image has to be gif. The function returns a pdf
image identifier.
<note><simpara>This function shouldn't be used anymore. Please use
the function <function>pdf_open_image_file</function> instead.
</simpara></note>
<example>
<title>Including a gif image</title>
@ -2037,6 +2088,9 @@ pdf_close_image($pdf, $im);
in the file with the name <parameter>filename</parameter>.
The format of the image has to be png. The function returns a pdf
image identifier.
<note><simpara>This function shouldn't be used anymore. Please use
the function <function>pdf_open_image_file</function> instead.
</simpara></note>
<example>
<title>Including a PNG image</title>
<programlisting>
@ -2060,6 +2114,50 @@ pdf_close_image ($pdf, $im);
</refsect1>
</refentry>
<refentry id="function.pdf-open-image-file">
<refnamediv>
<refname>PDF_open_image_file</refname>
<refpurpose>Reads an image from a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>pdf_open_image_file</function></funcdef>
<paramdef>int <parameter>PDF-Dokument</parameter></paramdef>
<paramdef>string <parameter>format</parameter></paramdef>
<paramdef>string <parameter>filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
The function <function>PDF_open_image_file</function> reads an image
of format <parameter>format</parameter> from the file
<parameter>filename</parameter>.
Possible formats are 'png', 'tiff', 'jpeg' und 'gif'.
The function returns a pdf image identifier.
<example>
<title>Inserting an image</title>
<programlisting>
&lt;?php
$pim = PDF_open_image_file($pdf, "png", "picture.png");
pdf_place_image($pdf, $pim, 100, 100, 1);
pdf_close_image($pdf, $pim);
?>
</programlisting>
</example></para>
<para>
Siehe auch <function>PDF_close_image</function>,
<function>PDF_open_jpeg</function>,
<function>PDF_open_gif</function>,
<function>PDF_open_tiff</function>,
<function>PDF_open_png</function>,
<function>PDF_execute_image</function>,
<function>PDF_place_image</function>,
<function>PDF_put_image</function>.</para>
</refsect1>
</refentry>
<refentry id="function.pdf-open-memory-image">
<refnamediv>
<refname>PDF_open_memory_image</refname>
@ -2124,7 +2222,10 @@ pdf_close_image($pdf, $pim);
The <function>PDF_open_jpeg</function> function opens an image stored
in the file with the name <parameter>filename</parameter>.
The format of the image has to be jpeg. The function returns a pdf
image identifier.</para>
image identifier.
<note><simpara>This function shouldn't be used anymore. Please use
the function <function>pdf_open_image_file</function> instead.
</simpara></note></para>
<para>
See also <function>PDF_close_image</function>,
<function>PDF_open_gif</function>,
@ -2136,6 +2237,43 @@ pdf_close_image($pdf, $pim);
</refsect1>
</refentry>
<refentry id="function.pdf-open-tiff">
<refnamediv>
<refname>PDF_open_tiff</refname>
<refpurpose>Öffnet ein TIFF-Bild</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>pdf_open_tiff</function></funcdef>
<paramdef>int <parameter>PDF-Dokument</parameter></paramdef>
<paramdef>string <parameter>Dateiname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
The <function>PDF_open_tiff</function> function opens an image stored
in the file with the name <parameter>filename</parameter>.
The format of the image has to be tiff. The function returns a pdf
image identifier.
<note><simpara>This function shouldn't be used anymore. Please use
the function <function>pdf_open_image_file</function> instead.
</simpara></note>
</para>
<para>
Siehe auch <function>PDF_close_image</function>,
<function>PDF_open_gif</function>,
<function>PDF_open_jpeg</function>,
<function>PDF_open_png</function>,
<function>PDF_open_memory_image</function>,
<function>PDF_execute_image</function>,
<function>PDF_place_image</function>,
<function>PDF_put_image</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.pdf-close-image">
<refnamediv>
<refname>PDF_close_image</refname>