cvs: phpdoc /en language-snippets.ent /en/reference/cpdf/functions cpdf-add-annotation.xml cpdf-add-outline.xml cpdf-arc.xml cpdf-begin-text.xml
cpdf-circle.xml cpdf-clip.xml cpdf-close.xml cpdf-closepath-fill-stroke.xml cpdf-closepath-stroke.xml cpdf-closepath.xml cpdf-continue-text.xml
cpdf-curveto.xml cpdf-end-text.xml cpdf-fill-stroke.xml cpdf-fill.xml cpdf-finalize-page.xml cpdf-finalize.xml cpdf-global-set-document-limits.xml
cpdf-import-jpeg.xml cpdf-lineto.xml cpdf-moveto.xml cpdf-newpath.xml cpdf-open.xml cpdf-output-buffer.xml cpdf-page-init.xml
cpdf-place-inline-image.xml cpdf-rect.xml cpdf-restore.xml cpdf-rlineto.xml cpdf-rmoveto.xml cpdf-rotate-text.xml cpdf-rotate.xml
cpdf-save-to-file.xml cpdf-save.xml cpdf-scale.xml cpdf-set-action-url.xml cpdf-set-char-spacing.xml cpdf-set-creator.xml cpdf-set-current-page.xml
cpdf-set-font-directories.xml cpdf-set-font-map-file.xml cpdf-set-font.xml cpdf-set-horiz-scaling.xml cpdf-set-keywords.xml cpdf-set-leadin! g.xml
cpdf-set-page-animation.xml cpdf-set-subject.xml cpdf-set-text-matrix.xml cpdf-set-text-pos.xml cpdf-set-text-rendering.xml cpdf-set-text-rise.xml
cpdf-set-title.xml cpdf-set-viewer-preferences.xml cpdf-set-word-spacing.xml cpdf-setdash.xml cpdf-setflat.xml cpdf-setgray-fill.xml
cpdf-setgray-stroke.xml cpdf-setgray.xml cpdf-setlinecap.xml cpdf-setlinejoin.xml cpdf-setlinewidth.xml cpdf-setmiterlimit.xml
cpdf-setrgbcolor-fill.xml cpdf-setrgbcolor-stroke.xml cpdf-setrgbcolor.xml cpdf-show-xy.xml cpdf-show.xml cpdf-stringwidth.xml cpdf-stroke.xml
cpdf-text.xml cpdf-translate.xml

didou Thu Jan 11 00:17:19 2007 UTC Modified files: /phpdoc/en language-snippets.ent /phpdoc/en/reference/cpdf/functions cpdf-add-annotation.xml cpdf-add-outline.xml cpdf-arc.xml cpdf-begin-text.xml cpdf-circle.xml cpdf-clip.xml cpdf-close.xml cpdf-closepath-fill-stroke.xml cpdf-closepath-stroke.xml cpdf-closepath.xml cpdf-continue-text.xml cpdf-curveto.xml cpdf-end-text.xml cpdf-fill-stroke.xml cpdf-fill.xml cpdf-finalize-page.xml cpdf-finalize.xml cpdf-global-set-document-limits.xml cpdf-import-jpeg.xml cpdf-lineto.xml cpdf-moveto.xml cpdf-newpath.xml cpdf-open.xml cpdf-output-buffer.xml cpdf-page-init.xml cpdf-place-inline-image.xml cpdf-rect.xml cpdf-restore.xml cpdf-rlineto.xml cpdf-rmoveto.xml cpdf-rotate-text.xml cpdf-rotate.xml cpdf-save-to-file.xml cpdf-save.xml cpdf-scale.xml cpdf-set-action-url.xml cpdf-set-char-spacing.xml cpdf-set-creator.xml cpdf-set-current-page.xml cpdf-set-font-directories.xml cpdf-set-font-map-file.xml cpdf-set-font.xml cpdf-set-horiz-scaling.xml cpdf-set-keywords.xml cpdf-set-leading.xml cpdf-set-page-animation.xml cpdf-set-subject.xml cpdf-set-text-matrix.xml cpdf-set-text-pos.xml cpdf-set-text-rendering.xml cpdf-set-text-rise.xml cpdf-set-title.xml cpdf-set-viewer-preferences.xml cpdf-set-word-spacing.xml cpdf-setdash.xml cpdf-setflat.xml cpdf-setgray-fill.xml cpdf-setgray-stroke.xml cpdf-setgray.xml cpdf-setlinecap.xml cpdf-setlinejoin.xml cpdf-setlinewidth.xml cpdf-setmiterlimit.xml cpdf-setrgbcolor-fill.xml cpdf-setrgbcolor-stroke.xml cpdf-setrgbcolor.xml cpdf-show-xy.xml cpdf-show.xml cpdf-stringwidth.xml cpdf-stroke.xml cpdf-text.xml cpdf-translate.xml Log: cpdf: Switch to new style

http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.178&r2=1.179&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.178 phpdoc/en/language-snippets.ent:1.179 --- phpdoc/en/language-snippets.ent:1.178 Sun Jan 7 23:40:10 2007 +++ phpdoc/en/language-snippets.ent Thu Jan 11 00:17:18 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.178 $ --> +<!-- $Revision: 1.179 $ --> <!-- Keep 'em sorted --> @@ -441,7 +441,7 @@ <!ENTITY sqlsafemode '<link linkend="ini.sql.safe-mode">SQL safe mode</link>'> -<!-- APD Notes --> +<!-- XMLWriter Notes --> <!ENTITY apd.debug-level.description '<varlistentry><term><parameter> debug_level</parameter></term><listitem><para>An integer which is formed by adding together the <literal>XXX_TRACE</literal> constants.</para><para>It is not recommended @@ -558,12 +558,22 @@ <constant>E_WARNING</constant> level warning is generated.</para></listitem> </varlistentry>'> -<!-- CPDF Unit length --> +<!-- CPDF Notes --> <!ENTITY cpdf.ul '<para>The optional parameter <parameter>mode</parameter> determines the unit length. If it is 0 or omitted the default unit as specified for the page is used. Otherwise the coordinates are measured in postscript points disregarding the current unit.</para>'> +<!ENTITY cpdf.mode.description '<varlistentry><term><parameter> +mode</parameter></term><listitem><para>The optional parameter <parameter>mode</parameter> +determines the unit length. If it is 0 or omitted the default unit as specified +for the page is used. Otherwise the coordinates are measured in postscript +points disregarding the current unit.</para></listitem></varlistentry>'> + +<!ENTITY cpdf.pdf-document.description '<varlistentry><term><parameter> +pdf_document</parameter></term><listitem><para>The document handle, returned by +<function>cpdf_open</function>.</para></listitem></varlistentry>'> + <!-- Xattr entities --> <!ENTITY xattr.namespace '<para>Extended attributes have two different namespaces: user and root namespace. User namespace is available for all users while root namespace http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.3 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-add-annotation"> <refnamediv> <refname>cpdf_add_annotation</refname> <refpurpose>Adds annotation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_add_annotation</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -20,15 +19,71 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_add_annotation</function> adds a note with the - lower left corner at (<parameter>llx</parameter>, - <parameter>lly</parameter>) and the upper right corner at - (<parameter>urx</parameter>, <parameter>ury</parameter>). + Adds a note at the specified point. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>llx</parameter></term> + <listitem> + <para> + Lower left X + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>lly</parameter></term> + <listitem> + <para> + Lower left Y + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>urx</parameter></term> + <listitem> + <para> + Upper right X + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>ury</parameter></term> + <listitem> + <para> + Upper right Y + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>title</parameter></term> + <listitem> + <para> + The title of the annotation + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The contents of the annotation + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> - - &cpdf.ul; - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-add-outline"> <refnamediv> <refname>cpdf_add_outline</refname> <refpurpose>Adds bookmark for current page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>cpdf_add_outline</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -18,9 +17,56 @@ <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_add_outline</function> function adds a bookmark - with text <parameter>text</parameter> that points to the current page. + Adds a bookmark with text <parameter>text</parameter> that points to the + current page. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>lastoutline</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sublevel</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>open</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pagenr</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The bookmark text + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Adding a page outline</title> @@ -34,7 +80,7 @@ // some drawing // ... cpdf_finalize($cpdf); -Header("Content-type: application/pdf"); +header("Content-type: application/pdf"); cpdf_output_buffer($cpdf); cpdf_close($cpdf); ?> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-arc.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-arc.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-arc.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-arc.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-arc.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-arc.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-arc"> <refnamediv> <refname>cpdf_arc</refname> <refpurpose>Draws an arc</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_arc</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -19,18 +18,70 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_arc</function> function draws an arc with - center at point - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>) - and radius <parameter>radius</parameter>, starting at angle - <parameter>start</parameter> and ending at angle - <parameter>end</parameter>. &return.success; + Draws an arc. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x</parameter></term> + <listitem> + <para> + The x-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y</parameter></term> + <listitem> + <para> + The y-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The arc radius + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + The starting angle, in degrees + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>end</parameter></term> + <listitem> + <para> + The ending angle, in degrees + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_circle</function>. + <simplelist> + <member><function>cpdf_circle</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml Thu Jan 11 00:17:18 2007 @@ -1,23 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-begin-text"> <refnamediv> <refname>cpdf_begin_text</refname> <refpurpose>Starts text section</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_begin_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_begin_text</function> function starts a text - section. &return.success; - The created text section must be ended with + Starts a text section. + </para> + <para> + The created text section must be ended with <function>cpdf_end_text</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Text output</title> @@ -33,8 +50,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_end_text</function>. + <simplelist> + <member><function>cpdf_end_text</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-circle.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-circle.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-circle.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-circle.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-circle.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-circle.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-circle"> <refnamediv> <refname>cpdf_circle</refname> <refpurpose>Draw a circle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_circle</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -17,16 +16,54 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_circle</function> function draws a circle with - center at point - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>) - and radius <parameter>radius</parameter>. &return.success; + Draws a circle. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the center + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>radius</parameter></term> + <listitem> + <para> + The circle radius + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_arc</function>. + <simplelist> + <member><function>cpdf_arc</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-clip.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-clip.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-clip.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-clip.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-clip.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-clip.xml Thu Jan 11 00:17:18 2007 @@ -1,20 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-clip"> <refnamediv> <refname>cpdf_clip</refname> <refpurpose>Clips to current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_clip</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_clip</function> function clips all drawing - to the current path. &return.success; + Clips all drawing to the current path. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-close.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-close.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-close.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-close.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-close.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-close.xml Thu Jan 11 00:17:18 2007 @@ -1,25 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-close"> <refnamediv> <refname>cpdf_close</refname> <refpurpose>Closes the pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_close</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_close</function> function closes the pdf document. - &return.success; This should be the last function even after + Closes the PDF document. + </para> + <para> + This should be the last function called, even after <function>cpdf_finalize</function>, <function>cpdf_output_buffer</function> - and <function>cpdf_save_to_file</function>. + or <function>cpdf_save_to_file</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_open</function>. + <simplelist> + <member><function>cpdf_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml Thu Jan 11 00:17:18 2007 @@ -1,30 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-closepath-fill-stroke"> <refnamediv> <refname>cpdf_closepath_fill_stroke</refname> <refpurpose>Close, fill and stroke current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_closepath_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_closepath_fill_stroke</function> function closes, - fills the interior of the current path with the current fill color and - draws current path. &return.success; + Closes, fills the interior of the current path with the current fill color + and draws current path. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_fill</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function> and - <function>cpdf_setrgbcolor</function>. + <simplelist> + <member><function>cpdf_closepath</function></member> + <member><function>cpdf_stroke</function></member> + <member><function>cpdf_fill</function></member> + <member><function>cpdf_setgray_fill</function></member> + <member><function>cpdf_setgray</function></member> + <member><function>cpdf_setrgbcolor_fill</function></member> + <member><function>cpdf_setrgbcolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml Thu Jan 11 00:17:18 2007 @@ -1,26 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-closepath-stroke"> <refnamediv> <refname>cpdf_closepath_stroke</refname> <refpurpose>Close path and draw line along path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_closepath_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_closepath_stroke</function> function is a - combination of <function>cpdf_closepath</function> and - <function>cpdf_stroke</function>. Then clears the path. + Closes the current path and draws a line along it. + </para> + <para> + <function>cpdf_closepath_stroke</function> is a combination of + <function>cpdf_closepath</function> and <function>cpdf_stroke</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_closepath</function> and - <function>cpdf_stroke</function>. + <simplelist> + <member><function>cpdf_closepath</function></member> + <member><function>cpdf_stroke</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml Thu Jan 11 00:17:18 2007 @@ -1,20 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-closepath"> <refnamediv> <refname>cpdf_closepath</refname> <refpurpose>Close path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_closepath</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_closepath</function> function closes the - current path. &return.success; + Closes the current path. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml Thu Jan 11 00:17:18 2007 @@ -1,27 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-continue-text"> <refnamediv> <refname>cpdf_continue_text</refname> <refpurpose>Output text in next line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_continue_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_continue_text</function> function outputs the - string in <parameter>text</parameter> in the next line. &return.success; + Outputs the string in <parameter>text</parameter> in the next line. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The string to output + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_show_xy</function>, - <function>cpdf_text</function>, - <function>cpdf_set_leading</function> and - <function>cpdf_set_text_pos</function>. + <simplelist> + <member><function>cpdf_show_xy</function></member> + <member><function>cpdf_text</function></member> + <member><function>cpdf_set_leading</function></member> + <member><function>cpdf_set_text_pos</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-curveto"> <refnamediv> <refname>cpdf_curveto</refname> <refpurpose>Draws a curve</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_curveto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -20,21 +19,84 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_curveto</function> function draws a Bezier curve - from the current point to the point + Draws a Bezier curve from the current point to the point (<parameter>x3</parameter>, <parameter>y3</parameter>) using (<parameter>x1</parameter>, <parameter>y1</parameter>) and - (<parameter>x2</parameter>, <parameter>y2</parameter>) as control - points. &return.success; + (<parameter>x2</parameter>, <parameter>y2</parameter>) as control points. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x1</parameter></term> + <listitem> + <para> + x-coordinate for the first control point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter></term> + <listitem> + <para> + y-coordinate for the first control point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter></term> + <listitem> + <para> + x-coordinate for the second control point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter></term> + <listitem> + <para> + y-coordinate for the second control point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x3</parameter></term> + <listitem> + <para> + x-coordinate for the target + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y3</parameter></term> + <listitem> + <para> + y-coordinate for the target + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_rlineto</function> and - <function>cpdf_lineto</function>. + <simplelist> + <member><function>cpdf_moveto</function></member> + <member><function>cpdf_rmoveto</function></member> + <member><function>cpdf_rlineto</function></member> + <member><function>cpdf_lineto</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml Thu Jan 11 00:17:18 2007 @@ -1,22 +1,37 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-end-text"> <refnamediv> <refname>cpdf_end_text</refname> <refpurpose>Ends text section</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_end_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_end_text</function> function ends a text - section which was started with <function>cpdf_begin_text</function>. + Ends a text section which was started with + <function>cpdf_begin_text</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Text output</title> @@ -32,8 +47,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_begin_text</function>. + <simplelist> + <member><function>cpdf_begin_text</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml Thu Jan 11 00:17:18 2007 @@ -1,30 +1,47 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-fill-stroke"> <refnamediv> <refname>cpdf_fill_stroke</refname> <refpurpose>Fill and stroke current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_fill_stroke</function> function fills the interior of - the current path with the current fill color and draws current path. + Fills the interior of the current path with the current fill color and + draws current path. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_fill</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function> and - <function>cpdf_setrgbcolor</function>. + <simplelist> + <member><function>cpdf_closepath</function></member> + <member><function>cpdf_stroke</function></member> + <member><function>cpdf_fill</function></member> + <member><function>cpdf_setgray_fill</function></member> + <member><function>cpdf_setgray</function></member> + <member><function>cpdf_setrgbcolor_fill</function></member> + <member><function>cpdf_setrgbcolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-fill.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-fill.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-fill.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-fill.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-fill.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-fill.xml Thu Jan 11 00:17:18 2007 @@ -1,28 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-fill"> <refnamediv> <refname>cpdf_fill</refname> <refpurpose>Fill current path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_fill</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_fill</function> function fills the interior of - the current path with the current fill color. &return.success; + Fills the interior of the current path with the current fill color. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function> and - <function>cpdf_setrgbcolor</function>. + <simplelist> + <member><function>cpdf_closepath</function></member> + <member><function>cpdf_stroke</function></member> + <member><function>cpdf_setgray_fill</function></member> + <member><function>cpdf_setgray</function></member> + <member><function>cpdf_setrgbcolor_fill</function></member> + <member><function>cpdf_setrgbcolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml Thu Jan 11 00:17:18 2007 @@ -1,28 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-finalize-page"> <refnamediv> <refname>cpdf_finalize_page</refname> <refpurpose>Ends page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_finalize_page</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>page_number</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_finalize_page</function> function ends the page - with page number <parameter>page_number</parameter>. &return.success; + Ends the page which number is <parameter>page_number</parameter>. </para> <para> - This function is only for saving memory. A finalized page takes - less memory but cannot be modified anymore. + This function is only used for saving memory. A finalized page takes less + memory but cannot be modified anymore. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>page_number</parameter></term> + <listitem> + <para> + The page number + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_page_init</function>. + <simplelist> + <member><function>cpdf_page_init</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml Thu Jan 11 00:17:18 2007 @@ -1,23 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-finalize"> <refnamediv> <refname>cpdf_finalize</refname> <refpurpose>Ends document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_finalize</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_finalize</function> function ends the document. - You still have to call <function>cpdf_close</function>. &return.success; + Ends the PDF document. </para> <para> - See also <function>cpdf_close</function>. + You still have to call <function>cpdf_close</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>cpdf_close</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml:1.4 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.cpdf-global-set-document-limits"> <refnamediv> <refname>cpdf_global_set_document_limits</refname> <refpurpose>Sets document limits for any pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_global_set_document_limits</methodname> <methodparam><type>int</type><parameter>maxpages</parameter></methodparam> @@ -17,13 +16,70 @@ <methodparam><type>int</type><parameter>maxobjects</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_global_set_document_limits</function> function sets - several document limits. This function has to be called before - <function>cpdf_open</function> to take effect. It sets the limits - for any document open afterwards. &return.success; + Sets several document limits. This function has to be called before + <function>cpdf_open</function> to take effect. It sets the limits for any + document open afterwards. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>maxPages</parameter></term> + <listitem> + <para> + The maximum number of pages + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxFonts</parameter></term> + <listitem> + <para> + The maximum number of fonts + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxImages</parameter></term> + <listitem> + <para> + The maximum number of images + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxAnnots</parameter></term> + <listitem> + <para> + The maximum number of annotations + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxObjects</parameter></term> + <listitem> + <para> + The maximum number of objects + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_open</function>. + <simplelist> + <member><function>cpdf_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml?r1=1.10&r2=1.11&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml:1.10 phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml:1.11 --- phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml:1.10 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-import-jpeg"> <refnamediv> <refname>cpdf_import_jpeg</refname> <refpurpose>Opens a JPEG image</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_import_jpeg</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -23,20 +23,101 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_import_jpeg</function> function opens an image - stored in the file with the name <parameter>file_name</parameter>. - The format of the image has to be jpeg. The - image is placed on the current page at position - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>). - The image is rotated by <parameter>angle</parameter> degrees. - <parameter>gsave</parameter> should be non-zero to allow this - function to operate correctly. + Opens a <literal>JPEG</literal> image. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>file_name</parameter></term> + <listitem> + <para> + The path to the image file. The format of the image has to be + <literal>JPEG</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the image + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the image + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + The image rotation angle, in degrees + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The image width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The image height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x_scale</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_scale</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>gsave</parameter></term> + <listitem> + <para> + Should be non-zero to allow this function to operate correctly + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_place_inline_image</function>. + <simplelist> + <member><function>cpdf_place_inline_image</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-lineto"> <refnamediv> <refname>cpdf_lineto</refname> <refpurpose>Draws a line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_lineto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -17,17 +16,48 @@ </methodsynopsis> <para> The <function>cpdf_lineto</function> function draws a line from - the current point to the point with coordinates - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>). + the current point to the specified point. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the destination point + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function> and - <function>cpdf_curveto</function>. + <simplelist> + <member><function>cpdf_moveto</function></member> + <member><function>cpdf_rmoveto</function></member> + <member><function>cpdf_curveto</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-moveto"> <refnamediv> <refname>cpdf_moveto</refname> <refpurpose>Sets current point</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_moveto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,13 +15,39 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_moveto</function> function set the current - point to the coordinates <parameter>x_coor</parameter> and - <parameter>y_coor</parameter>. &return.success; + Sets the current point to the given coordinates. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> - - &cpdf.ul; - </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml Thu Jan 11 00:17:18 2007 @@ -1,21 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-newpath"> <refnamediv> <refname>cpdf_newpath</refname> <refpurpose>Starts a new path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_newpath</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_newpath</function> starts a new path on the - document given by the <parameter>pdf_document</parameter> - parameter. &return.success; + Starts a new path on the document. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-open.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-open.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-open.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-open.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-open.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-open.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-open"> <refnamediv> <refname>cpdf_open</refname> <refpurpose>Opens a new pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>cpdf_open</methodname> <methodparam><type>int</type><parameter>compression</parameter></methodparam> @@ -15,32 +14,71 @@ <methodparam choice="opt"><type>array</type><parameter>doc_limits</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_open</function> function opens - a new pdf document. The first parameter turns document compression - on if it is unequal to 0. The second optional parameter sets the - file in which the document is written. If it is omitted the document - is created in memory and can either be written into a file with - the <function>cpdf_save_to_file</function> or written to standard - output with <function>cpdf_output_buffer</function>. - <note> - <simpara> - The return value will be needed in further versions of ClibPDF - as the first parameter in all other functions which are writing - to the pdf document. - </simpara> - <simpara> - The ClibPDF library takes the filename "-" as a synonym for - stdout. If PHP is compiled as an apache module this will not - work because the way ClibPDF outputs to stdout does not work - with apache. You can solve this problem by skipping the - filename and using <function>cpdf_output_buffer</function> to - output the pdf document. - </simpara> - </note> + Opens a new PDF document. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>compression</parameter></term> + <listitem> + <para> + If different from 0, document compression is turned on + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Sets the file in which the document is written. <literal>-</literal> + is a synonym for stdout. + </para> + <para> + If omitted, the document is created in memory and can either be + written into a file with <function>cpdf_save_to_file</function> or + written to standard output with + <function>cpdf_output_buffer</function>. + </para> + <note> + <para> + Using stdout will not work if PHP is compiled as an apache module. + You can solve this problem by skipping this parameter filename and + using <function>cpdf_output_buffer</function> later to output the + PDF document. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>doc_limits</parameter></term> + <listitem> + <para> + An array defining the document limitation. See + <function>cpdf_global_set_document_limits</function> for more + information + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a document handle, needed as the first parameter for all other + functions of the library. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_close</function> and - <function>cpdf_output_buffer</function>. + <simplelist> + <member><function>cpdf_close</function></member> + <member><function>cpdf_output_buffer</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml Thu Jan 11 00:17:18 2007 @@ -1,25 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-output-buffer"> <refnamediv> <refname>cpdf_output_buffer</refname> <refpurpose>Outputs the pdf document in memory buffer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_output_buffer</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_output_buffer</function> function outputs - the pdf document to stdout. The document has to be created in memory which - is the case if <function>cpdf_open</function> has been called with - no filename parameter. &return.success; + Outputs the pdf document to stdout. </para> <para> - See also <function>cpdf_open</function>. + The document has to be created in memory which is the case if + <function>cpdf_open</function> has been called without the file name + parameter. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>cpdf_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-page-init"> <refnamediv> <refname>cpdf_page_init</refname> <refpurpose>Starts new page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_page_init</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -18,19 +17,71 @@ <methodparam choice="opt"><type>float</type><parameter>unit</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_page_init</function> function starts a new - page with height <parameter>height</parameter> and width - <parameter>width</parameter>. &return.success; - The page has number <parameter>page_number</parameter> and orientation - <parameter>orientation</parameter>. <parameter>orientation</parameter> - can be 0 for portrait and 1 for landscape. The last optional parameter - <parameter>unit</parameter> sets the unit for the coordinate system. - The value should be the number of postscript points per unit. Since - one inch is equal to 72 points, a value of 72 would set the unit - to one inch. The default is also 72. + Starts a new page. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>page_number</parameter></term> + <listitem> + <para> + The page number + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>orientation</parameter></term> + <listitem> + <para> + 0 for portrait and 1 for landscape + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The page height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The page width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>unit</parameter></term> + <listitem> + <para> + The unit for the coordinate system. The value should be the number of + postscript points per unit. Since one inch is equal to 72 points, a + value of 72 would set the unit to one inch. The default is also 72. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_current_page</function>. + <simplelist> + <member><function>cpdf_set_current_page</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml:1.9 phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml:1.10 --- phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml:1.9 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.10 $ --> <refentry id="function.cpdf-place-inline-image"> <refnamediv> <refname>cpdf_place_inline_image</refname> <refpurpose>Places an image on the page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_place_inline_image</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -21,15 +20,9 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_place_inline_image</function> function places - an image created with the PHP image functions on the page at - position (<parameter>x_coor</parameter>, - <parameter>y_coor</parameter>). The image can be scaled at the - same time. &return.success; + Places an image created with the PHP image functions on the page. + The image can be scaled at the same time. </para> - - &cpdf.ul; - <note> <simpara> This function is only available if PHP was compiled with the GD Graphics @@ -37,8 +30,84 @@ installation instructions for further information. </simpara> </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>image</parameter></term> + <listitem> + <para> + An image created with the PHP image functions + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the image + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the image + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + The image rotation angle, in degrees + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The image width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The image height + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>gsave</parameter></term> + <listitem> + <para> + Should be non-zero to allow this function to operate correctly + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_import_jpeg</function>. + <simplelist> + <member><function>cpdf_import_jpeg</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-rect.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-rect.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rect.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-rect.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-rect.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-rect.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-rect"> <refnamediv> <refname>cpdf_rect</refname> <refpurpose>Draw a rectangle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_rect</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -18,15 +17,58 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_rect</function> function draws a rectangle with - its lower left corner at point - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>). - This width is set to <parameter>width</parameter>. - This height is set to <parameter>height</parameter>. &return.success; + Draws a rectangle. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the lower left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the lower left corner + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The rectangle width + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>height</parameter></term> + <listitem> + <para> + The rectangle height + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Drawing a rectangle</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-restore.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-restore.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-restore.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-restore.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-restore.xml:1.5 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-restore.xml Thu Jan 11 00:17:18 2007 @@ -1,24 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-restore"> <refnamediv> <refname>cpdf_restore</refname> <refpurpose>Restores formerly saved environment</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_restore</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_restore</function> function restores the - environment saved with <function>cpdf_save</function>. It works - like the postscript command grestore. Very useful if you want - to translate or rotate an object without effecting other objects. + Restores the environment saved with <function>cpdf_save</function>. It + works like the postscript command grestore. Very useful if you want to + translate or rotate an object without effecting other objects. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Save/Restore</title> @@ -33,8 +47,13 @@ </programlisting> </example> </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_save</function>. + <simplelist> + <member><function>cpdf_save</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-rlineto"> <refnamediv> <refname>cpdf_rlineto</refname> <refpurpose>Draws a line</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_rlineto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,18 +15,49 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_rlineto</function> function draws a line from - the current point to the relative point with coordinates - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>). + The <function>cpdf_rlineto</function> function draws a line from the + current point to the given relative point. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the destination point + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function> and - <function>cpdf_curveto</function>. + <simplelist> + <member><function>cpdf_moveto</function></member> + <member><function>cpdf_rmoveto</function></member> + <member><function>cpdf_curveto</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml:1.6 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-rmoveto"> <refnamediv> <refname>cpdf_rmoveto</refname> <refpurpose>Sets current point</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_rmoveto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,15 +15,46 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_rmoveto</function> function set the current point - relative to the coordinates <parameter>x_coor</parameter> and - <parameter>y_coor</parameter>. &return.success; + Set the current point relative to the given coordinates. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the destination point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the destination point + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_moveto</function>. + <simplelist> + <member><function>cpdf_moveto</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml:1.4 Tue Jan 9 19:03:46 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-rotate-text'> <refnamediv> <refname>cpdf_rotate_text</refname> <refpurpose>Sets text rotation angle</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_rotate_text</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml Thu Jan 11 00:17:18 2007 @@ -1,21 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-rotate"> <refnamediv> <refname>cpdf_rotate</refname> <refpurpose>Sets rotation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_rotate</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>angle</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_rotate</function> function set the rotation in - degrees to <parameter>angle</parameter>. &return.success; + Sets the rotation in degrees to <parameter>angle</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>angle</parameter></term> + <listitem> + <para> + The angle, in degrees + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml Thu Jan 11 00:17:18 2007 @@ -1,30 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-save-to-file"> <refnamediv> <refname>cpdf_save_to_file</refname> <refpurpose>Writes the pdf document into a file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_save_to_file</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_save_to_file</function> function outputs - the pdf document into a file if it has been created in memory. - &return.success; + Outputs the PDF document into a file if it has been created in memory. </para> <para> - This function is not needed if the pdf document has been open + This function is not needed if the PDF document has been open by specifying a filename as a parameter of <function>cpdf_open</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The path to the saved PDF document + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_output_buffer</function> and - <function>cpdf_open</function>. + <simplelist> + <member><function>cpdf_output_buffer</function></member> + <member><function>cpdf_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-save.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-save.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-save.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-save.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-save.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-save.xml Thu Jan 11 00:17:18 2007 @@ -1,25 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-save"> <refnamediv> <refname>cpdf_save</refname> <refpurpose>Saves current environment</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_save</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_save</function> function saves the current - environment. It works like the postscript command gsave. Very - useful if you want to translate or rotate an object without effecting - other objects. &return.success; + Saves the current environment. It works like the postscript command gsave. + Very useful if you want to translate or rotate an object without effecting + other objects. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_restore</function>. + <simplelist> + <member><function>cpdf_restore</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-scale.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-scale.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-scale.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-scale.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-scale.xml:1.6 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-scale.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-scale"> <refnamediv> <refname>cpdf_scale</refname> <refpurpose>Sets scaling</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_scale</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -15,8 +14,37 @@ <methodparam><type>float</type><parameter>y_scale</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_scale</function> function set the scaling factor - in both directions. &return.success; + Sets the scaling factor in both directions. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_scale</parameter></term> + <listitem> + <para> + The X scale percent to set. Default to <literal>0.0</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_scale</parameter></term> + <listitem> + <para> + The Y scale percent to set. Default to <literal>0.0</literal> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml:1.4 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id='function.cpdf-set-action-url'> <refnamediv> <refname>cpdf_set_action_url</refname> <refpurpose>Sets hyperlink</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_action_url</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml Thu Jan 11 00:17:18 2007 @@ -1,25 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-char-spacing"> <refnamediv> <refname>cpdf_set_char_spacing</refname> <refpurpose>Sets character spacing</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_char_spacing</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>space</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_char_spacing</function> function sets the - spacing between characters. &return.success; + Sets the spacing between characters. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>space</parameter></term> + <listitem> + <para> + Distance between individual characters in a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_word_spacing</function> and - <function>cpdf_set_leading</function>. + <simplelist> + <member><function>cpdf_set_word_spacing</function></member> + <member><function>cpdf_set_leading</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml Thu Jan 11 00:17:18 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-creator"> <refnamediv> <refname>cpdf_set_creator</refname> <refpurpose>Sets the creator field in the pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_creator</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>creator</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_creator</function> function sets the - creator of a pdf document. &return.success; + Sets the creator of a PDF document. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>creator</parameter></term> + <listitem> + <para> + The creator of the document + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_subject</function>, - <function>cpdf_set_title</function> and - <function>cpdf_set_keywords</function>. + <simplelist> + <member><function>cpdf_set_subject</function></member> + <member><function>cpdf_set_title</function></member> + <member><function>cpdf_set_keywords</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml Thu Jan 11 00:17:18 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-current-page"> <refnamediv> <refname>cpdf_set_current_page</refname> <refpurpose>Sets current page</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_current_page</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>page_number</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_current_page</function> function set the page - on which all operations are performed. One can switch between pages - until a page is finished with <function>cpdf_finalize_page</function>. + Sets the page on which all operations are performed. One can switch + between pages until a page is finished with + <function>cpdf_finalize_page</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>page_number</parameter></term> + <listitem> + <para> + The page number + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_finalize_page</function>. + <simplelist> + <member><function>cpdf_finalize_page</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml:1.4 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-set-font-directories'> <refnamediv> <refname>cpdf_set_font_directories</refname> <refpurpose>Sets directories to search when using external fonts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_font_directories</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml:1.4 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-set-font-map-file'> <refnamediv> <refname>cpdf_set_font_map_file</refname> <refpurpose>Sets fontname to filename translation map when using external fonts</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_font_map_file</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml:1.7 phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml:1.8 --- phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml:1.7 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.cpdf-set-font"> <refnamediv> <refname>cpdf_set_font</refname> <refpurpose>Select the current font face and size</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_font</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,19 +15,53 @@ <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_font</function> function sets the - current font face, font size and encoding. Currently only - the standard postscript fonts are supported. &return.success; + Sets the current font face, font size and encoding. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The last parameter <parameter>encoding</parameter> can take the - following values: "MacRomanEncoding", "MacExpertEncoding", - "WinAnsiEncoding", and "&null;". "&null;" stands for the font's - built-in encoding. + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>font_name</parameter></term> + <listitem> + <para> + The font name. Currently only the standard postscript fonts are + supported. + </para> + <para> + See the ClibPDF Manual for more information, especially on how to + support Asian fonts. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem> + <para> + The font size + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + Can take the following values: <literal>MacRomanEncoding</literal>, + <literal>MacExpertEncoding</literal>, + <literal>WinAnsiEncoding</literal>, and <literal>NULL</literal> (the + font's built-in encoding). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See the ClibPDF Manual for more information, especially how to support - Asian fonts. + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml Thu Jan 11 00:17:18 2007 @@ -1,21 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-horiz-scaling"> <refnamediv> <refname>cpdf_set_horiz_scaling</refname> <refpurpose>Sets horizontal scaling of text</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_horiz_scaling</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>scale</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_horiz_scaling</function> function sets the - horizontal scaling to <parameter>scale</parameter> percent. + Sets the horizontal scaling to <parameter>scale</parameter> percent. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>scale</parameter></term> + <listitem> + <para> + The scale percent to set + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml Thu Jan 11 00:17:18 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-keywords"> <refnamediv> <refname>cpdf_set_keywords</refname> <refpurpose>Sets the keywords field of the pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_keywords</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>keywords</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_keywords</function> function sets the - keywords of a pdf document. &return.success; + Sets the keywords of the PDF document. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>keywords</parameter></term> + <listitem> + <para> + The keywords to set on the document + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_title</function>, - <function>cpdf_set_creator</function> and - <function>cpdf_set_subject</function>. + <simplelist> + <member><function>cpdf_set_title</function></member> + <member><function>cpdf_set_creator</function></member> + <member><function>cpdf_set_subject</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml:1.6 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml Thu Jan 11 00:17:18 2007 @@ -1,26 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.6 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-set-leading"> <refnamediv> <refname>cpdf_set_leading</refname> <refpurpose>Sets distance between text lines</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_leading</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>distance</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_leading</function> function sets the - <parameter>distance</parameter> between text lines. This will - be used if text is output by <function>cpdf_continue_text</function>. + Sets the <parameter>distance</parameter> between text lines. This will be + used if text is output by <function>cpdf_continue_text</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>distance</parameter></term> + <listitem> + <para> + The distance between text lines, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_continue_text</function>. + <simplelist> + <member><function>cpdf_continue_text</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml:1.6 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-set-page-animation"> <refnamediv> <refname>cpdf_set_page_animation</refname> <refpurpose>Sets duration between pages</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_page_animation</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -18,36 +17,80 @@ <methodparam><type>int</type><parameter>inout</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_page_animation</function> function set the - transition between following pages. &return.success; + Sets the transition between following pages. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The value of <parameter>transition</parameter> - can be - <simplelist> - <member>0 for none,</member> - <member> - 1 for two lines sweeping across the screen reveal the page, - </member> - <member> - 2 for multiple lines sweeping across the screen reveal the page, - </member> - <member>3 for a box reveals the page,</member> - <member> - 4 for a single line sweeping across the screen reveals the page, - </member> - <member>5 for the old page dissolves to reveal the page,</member> - <member> - 6 for the dissolve effect moves from one screen edge to another, - </member> - <member> - 7 for the old page is simply replaced by the new page (default) - </member> - </simplelist> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>transition</parameter></term> + <listitem> + <para> + The value of <parameter>transition</parameter> + can be + <simplelist> + <member>0 for none,</member> + <member> + 1 for two lines sweeping across the screen reveal the page, + </member> + <member> + 2 for multiple lines sweeping across the screen reveal the page, + </member> + <member>3 for a box reveals the page,</member> + <member> + 4 for a single line sweeping across the screen reveals the page, + </member> + <member>5 for the old page dissolves to reveal the page,</member> + <member> + 6 for the dissolve effect moves from one screen edge to another, + </member> + <member> + 7 for the old page is simply replaced by the new page (default) + </member> + </simplelist> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>duration</parameter></term> + <listitem> + <para> + The value of <parameter>duration</parameter> is the number of seconds + between page flipping. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>direction</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>orientation</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>inout</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The value of <parameter>duration</parameter> is the number of seconds - between page flipping. + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml:1.4 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml Thu Jan 11 00:17:18 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.cpdf-set-subject"> <refnamediv> <refname>cpdf_set_subject</refname> <refpurpose>Sets the subject field of the pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_subject</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>subject</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_subject</function> function sets the - <parameter>subject</parameter> of a pdf document. &return.success; + Sets the <parameter>subject</parameter> of the PDF document. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>subject</parameter></term> + <listitem> + <para> + The subject of the document + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_title</function>, - <function>cpdf_set_creator</function> and - <function>cpdf_set_keywords</function>. + <simplelist> + <member><function>cpdf_set_title</function></member> + <member><function>cpdf_set_creator</function></member> + <member><function>cpdf_set_keywords</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml Thu Jan 11 00:17:18 2007 @@ -1,22 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-text-matrix"> <refnamediv> <refname>cpdf_set_text_matrix</refname> <refpurpose>Sets the text matrix</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_text_matrix</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>array</type><parameter>matrix</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_text_matrix</function> function sets - a <parameter>matrix</parameter> which describes a transformation - applied on the current text font. &return.success; + Sets a <parameter>matrix</parameter> which describes a transformation + applied on the current text font. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>matrix</parameter></term> + <listitem> + <para> + An array of six elements describing the transformation + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml:1.6 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml Thu Jan 11 00:17:18 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-set-text-pos"> <refnamediv> <refname>cpdf_set_text_pos</refname> <refpurpose>Sets text position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_text_pos</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,16 +15,48 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_text_pos</function> function sets the - position of text for the next <function>cpdf_show</function> - function call. &return.success; + Sets the position of text for the next <function>cpdf_show</function> + call. </para> - - &cpdf.ul; - + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the text position + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the text position + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_show</function> and - <function>cpdf_text</function>. + <simplelist> + <member><function>cpdf_show</function></member> + <member><function>cpdf_text</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml Thu Jan 11 00:17:19 2007 @@ -1,28 +1,45 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-text-rendering"> <refnamediv> <refname>cpdf_set_text_rendering</refname> <refpurpose>Determines how text is rendered</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_text_rendering</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>rendermode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_text_rendering</function> function - determines how text is rendered. &return.success; + Determines how the text is rendered. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>rendermode</parameter></term> + <listitem> + <para> + The possible values for <parameter>rendermode</parameter> are 0=fill + text, 1=stroke text, 2=fill and stroke text, 3=invisible, 4=fill + text and add it to clipping path, 5=stroke text and add it to + clipping path, 6=fill and stroke text and add it to clipping + path, 7=add it to clipping path. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The possible values for <parameter>rendermode</parameter> are 0=fill - text, 1=stroke text, 2=fill and stroke text, 3=invisible, 4=fill - text and add it to clipping path, 5=stroke text and add it to - clipping path, 6=fill and stroke text and add it to clipping - path, 7=add it to clipping path. + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml Thu Jan 11 00:17:19 2007 @@ -1,21 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-text-rise"> <refnamediv> <refname>cpdf_set_text_rise</refname> <refpurpose>Sets the text rise</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_text_rise</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_text_rise</function> function sets the - text rising to <parameter>value</parameter> units. &return.success; + Sets the text rising to <parameter>value</parameter> units. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The text rising, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml Thu Jan 11 00:17:19 2007 @@ -1,26 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-title"> <refnamediv> <refname>cpdf_set_title</refname> <refpurpose>Sets the title field of the pdf document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_title</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>title</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_title</function> function sets the - <parameter>title</parameter> of a pdf document. &return.success; + Sets the <parameter>title</parameter> of a PDF document. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>title</parameter></term> + <listitem> + <para> + The title of the document + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_subject</function>, - <function>cpdf_set_creator</function> and - <function>cpdf_set_keywords</function>. + <simplelist> + <member><function>cpdf_set_subject</function></member> + <member><function>cpdf_set_creator</function></member> + <member><function>cpdf_set_keywords</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml:1.4 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-set-viewer-preferences'> <refnamediv> <refname>cpdf_set_viewer_preferences</refname> <refpurpose>How to show the document in the viewer</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_viewer_preferences</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml Thu Jan 11 00:17:19 2007 @@ -1,25 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-set-word-spacing"> <refnamediv> <refname>cpdf_set_word_spacing</refname> <refpurpose>Sets spacing between words</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_set_word_spacing</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>space</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_word_spacing</function> function sets the - spacing between words. &return.success; + Sets the spacing between words. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>space</parameter></term> + <listitem> + <para> + The spacing, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_set_char_spacing</function> and - <function>cpdf_set_leading</function>. + <simplelist> + <member><function>cpdf_set_char_spacing</function></member> + <member><function>cpdf_set_leading</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setdash"> <refnamediv> <refname>cpdf_setdash</refname> <refpurpose>Sets dash pattern</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setdash</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -15,10 +14,38 @@ <methodparam><type>float</type><parameter>black</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setdash</function> function set the dash - pattern <parameter>white</parameter> white units and - <parameter>black</parameter> black units. If both are 0 a solid - line is set. &return.success; + Sets the dash pattern to the given one. If both parameters are 0, a solid + line is set. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>white</parameter></term> + <listitem> + <para> + White units, as a float + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>black</parameter></term> + <listitem> + <para> + Black units, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml Thu Jan 11 00:17:19 2007 @@ -1,21 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setflat"> <refnamediv> <refname>cpdf_setflat</refname> <refpurpose>Sets flatness</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setflat</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setflat</function> function set the flatness to - a value between 0 and 100. &return.success; + Sets the flatness. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The flatness as a float, between 0 and 100 + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml Thu Jan 11 00:17:19 2007 @@ -1,24 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setgray-fill"> <refnamediv> <refname>cpdf_setgray_fill</refname> <refpurpose>Sets filling color to gray value</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setgray_fill</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setgray_fill</function> function sets the current - gray <parameter>value</parameter> to fill a path. &return.success; + Sets the current gray <parameter>value</parameter> to fill a path. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + The gray value, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_setrgbcolor_fill</function>. + <simplelist> + <member><function>cpdf_setrgbcolor_fill</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml Thu Jan 11 00:17:19 2007 @@ -1,24 +1,49 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setgray-stroke"> <refnamediv> <refname>cpdf_setgray_stroke</refname> <refpurpose>Sets drawing color to gray value</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setgray_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>gray_value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setgray_stroke</function> function sets the current - drawing color to the given gray value. &return.success; + Sets the current drawing color to the given gray value. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>gray_value</parameter></term> + <listitem> + <para> + The gray value, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_setrgbcolor_stroke</function>. + <simplelist> + <member><function>cpdf_setrgbcolor_stroke</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml Thu Jan 11 00:17:19 2007 @@ -1,25 +1,50 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setgray"> <refnamediv> <refname>cpdf_setgray</refname> <refpurpose>Sets drawing and filling color to gray value</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setgray</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>gray_value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setgray</function> function sets the current - drawing and filling color to the given gray value. &return.success; + Sets the current drawing and filling color to the given gray value. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>gray_value</parameter></term> + <listitem> + <para> + The gray value, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_setrgbcolor_stroke</function> and - <function>cpdf_setrgbcolor_fill</function>. + <simplelist> + <member><function>cpdf_setrgbcolor_stroke</function></member> + <member><function>cpdf_setrgbcolor_fill</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml Thu Jan 11 00:17:19 2007 @@ -1,22 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setlinecap"> <refnamediv> <refname>cpdf_setlinecap</refname> <refpurpose>Sets linecap parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setlinecap</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setlinecap</function> function set the linecap - parameter between a <parameter>value</parameter> of 0 and 2. - 0 = butt end, 1 = round, 2 = projecting square. &return.success; + Sets the linecap parameter. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + 0 = butt end, 1 = round, 2 = projecting square + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml:1.6 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml Thu Jan 11 00:17:19 2007 @@ -1,22 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-setlinejoin"> <refnamediv> <refname>cpdf_setlinejoin</refname> <refpurpose>Sets linejoin parameter</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setlinejoin</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setlinejoin</function> function set the - linejoin parameter between a <parameter>value</parameter> of - 0 and 2. 0 = miter, 1 = round, 2 = bevel. &return.success; + Set the linejoin parameter. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + 0 = miter, 1 = round, 2 = bevel + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml Thu Jan 11 00:17:19 2007 @@ -1,21 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setlinewidth"> <refnamediv> <refname>cpdf_setlinewidth</refname> <refpurpose>Sets line width</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setlinewidth</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>width</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setlinewidth</function> function set the line - width to <parameter>width</parameter>. &return.success; + Set the line width. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The line width, as a float + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml Thu Jan 11 00:17:19 2007 @@ -1,21 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setmiterlimit"> <refnamediv> <refname>cpdf_setmiterlimit</refname> <refpurpose>Sets miter limit</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setmiterlimit</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setmiterlimit</function> function set the - miter limit to a value greater or equal than 1. &return.success; + Sets the miter limit. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>width</parameter></term> + <listitem> + <para> + The miter limit. Must be greater or equal than 1 + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setrgbcolor-fill"> <refnamediv> <refname>cpdf_setrgbcolor_fill</refname> <refpurpose>Sets filling color to rgb color value</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setrgbcolor_fill</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,18 +15,54 @@ <methodparam><type>float</type><parameter>blue_value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setrgbcolor_fill</function> function sets the current - rgb color value to fill a path. &return.success; + Sets the current rgb color value to fill a path. </para> - <note> - <para> - The values are expected to be floating point values between 0.0 and - 1.0. (i.e black is (0.0, 0.0, 0.0) and white is (1.0, 1.0, 1.0)). - </para> - </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>red_value</parameter></term> + <listitem> + <para> + The red value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green_value</parameter></term> + <listitem> + <para> + The green value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue_value</parameter></term> + <listitem> + <para> + The blue value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_setrgbcolor_stroke</function> and - <function>cpdf_setrgbcolor</function>. + <simplelist> + <member><function>cpdf_setrgbcolor_stroke</function></member> + <member><function>cpdf_setrgbcolor</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setrgbcolor-stroke"> <refnamediv> <refname>cpdf_setrgbcolor_stroke</refname> <refpurpose>Sets drawing color to rgb color value</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setrgbcolor_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,18 +15,54 @@ <methodparam><type>float</type><parameter>blue_value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setrgbcolor_stroke</function> function sets the current - drawing color to the given rgb color value. &return.success; + Sets the current drawing color to the given rgb color value. </para> - <note> - <para> - The values are expected to be floating point values between 0.0 and - 1.0. (i.e black is (0.0, 0.0, 0.0) and white is (1.0, 1.0, 1.0)). - </para> - </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>red_value</parameter></term> + <listitem> + <para> + The red value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green_value</parameter></term> + <listitem> + <para> + The green value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue_value</parameter></term> + <listitem> + <para> + The blue value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_setrgbcolor_fill</function> and - <function>cpdf_setrgbcolor</function>. + <simplelist> + <member><function>cpdf_setrgbcolor</function></member> + <member><function>cpdf_setrgbcolor_fill</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-setrgbcolor"> <refnamediv> <refname>cpdf_setrgbcolor</refname> <refpurpose>Sets drawing and filling color to rgb color value</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_setrgbcolor</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -16,18 +15,54 @@ <methodparam><type>float</type><parameter>blue_value</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_setrgbcolor</function> function sets the current - drawing and filling color to the given rgb color value. &return.success; + Sets the current drawing and filling color to the given rgb color value. </para> - <note> - <para> - The values are expected to be floating point values between 0.0 and - 1.0. (i.e black is (0.0, 0.0, 0.0) and white is (1.0, 1.0, 1.0)). - </para> - </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>red_value</parameter></term> + <listitem> + <para> + The red value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>green_value</parameter></term> + <listitem> + <para> + The green value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>blue_value</parameter></term> + <listitem> + <para> + The blue value, as a float between 0.0 (black) and 1.0 (white) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_setrgbcolor_stroke</function> and - <function>cpdf_setrgbcolor_fill</function>. + <simplelist> + <member><function>cpdf_setrgbcolor_stroke</function></member> + <member><function>cpdf_setrgbcolor_fill</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml:1.6 phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml:1.7 --- phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml:1.6 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.cpdf-show-xy"> <refnamediv> <refname>cpdf_show_xy</refname> <refpurpose>Output text at position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_show_xy</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -17,14 +16,8 @@ <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_show_xy</function> function outputs the - string <parameter>text</parameter> at position with coordinates - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>). - &return.success; + Outputs the string <parameter>text</parameter> at the given position. </para> - - &cpdf.ul; - <para> <note> <simpara> @@ -33,8 +26,52 @@ </simpara> </note> </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the text position + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the text position + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_text</function>. + <simplelist> + <member><function>cpdf_text</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-show.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-show.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-show.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-show.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-show.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-show.xml Thu Jan 11 00:17:19 2007 @@ -1,27 +1,51 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-show"> <refnamediv> <refname>cpdf_show</refname> <refpurpose>Output text at current position</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_show</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_show</function> function outputs the - string in <parameter>text</parameter> at the current position. + Outputs a <parameter>text</parameter> at the current position. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text, as a string + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_text</function>, - <function>cpdf_begin_text</function> and - <function>cpdf_end_text</function>. + <simplelist> + <member><function>cpdf_text</function></member> + <member><function>cpdf_begin_text</function></member> + <member><function>cpdf_end_text</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-stringwidth.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-stringwidth.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-stringwidth.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-stringwidth.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-stringwidth.xml:1.4 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-stringwidth.xml Thu Jan 11 00:17:19 2007 @@ -1,25 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.cpdf-stringwidth"> <refnamediv> <refname>cpdf_stringwidth</refname> <refpurpose>Returns width of text in current font</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>float</type><methodname>cpdf_stringwidth</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_stringwidth</function> function returns the - width of the string in <parameter>text</parameter>. It requires - a font to be set before. + Returns the width of the string in <parameter>text</parameter>. </para> <para> - See also <function>cpdf_set_font</function>. + This function requires a font to be set before. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text, as a string + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the width of <parameter>text</parameter>. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>cpdf_set_font</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml:1.5 phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml:1.6 --- phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml:1.5 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml Thu Jan 11 00:17:19 2007 @@ -1,24 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.cpdf-stroke"> <refnamediv> <refname>cpdf_stroke</refname> <refpurpose>Draw line along path</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_stroke</function> function draws a line along - current path. &return.success; + Draws a line along current path. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_closepath</function> and - <function>cpdf_closepath_stroke</function>. + <simplelist> + <member><function>cpdf_closepath</function></member> + <member><function>cpdf_closepath_stroke</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-text.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-text.xml:1.7 phpdoc/en/reference/cpdf/functions/cpdf-text.xml:1.8 --- phpdoc/en/reference/cpdf/functions/cpdf-text.xml:1.7 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-text.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.cpdf-text"> <refnamediv> <refname>cpdf_text</refname> <refpurpose>Output text with parameters</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -19,27 +18,71 @@ <methodparam choice="opt"><type>int</type><parameter>alignmode</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_text</function> function outputs the string - <parameter>text</parameter> at position with coordinates - (<parameter>x_coor</parameter>, <parameter>y_coor</parameter>). - &return.success; - </para> - - &cpdf.ul; - - <para> - The optional parameter <parameter>orientation</parameter> is the - rotation of the text in degree. + Outputs the string <parameter>text</parameter> at the given position. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The optional parameter <parameter>alignmode</parameter> determines - how the text is aligned. + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>text</parameter></term> + <listitem> + <para> + The text + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the text position + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the text position + </para> + </listitem> + </varlistentry> + &cpdf.mode.description; + <varlistentry> + <term><parameter>orientation</parameter></term> + <listitem> + <para> + Rotation of the text in degrees + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>alignmode</parameter></term> + <listitem> + <para> + Ddetermines how the text is aligned. See the ClibPDF documentation for + possible values. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See the ClibPDF documentation for possible values. + &return.success; </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>cpdf_show_xy</function>. + <simplelist> + <member><function>cpdf_show_xy</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/cpdf/functions/cpdf-translate.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/cpdf/functions/cpdf-translate.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-translate.xml:1.7 phpdoc/en/reference/cpdf/functions/cpdf-translate.xml:1.8 --- phpdoc/en/reference/cpdf/functions/cpdf-translate.xml:1.7 Tue Jan 9 19:03:47 2007 +++ phpdoc/en/reference/cpdf/functions/cpdf-translate.xml Thu Jan 11 00:17:19 2007 @@ -1,13 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.cpdf-translate"> <refnamediv> <refname>cpdf_translate</refname> <refpurpose>Sets origin of coordinate system</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>cpdf_translate</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> @@ -15,13 +14,38 @@ <methodparam><type>float</type><parameter>y_coor</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_translate</function> function set the origin of - coordinate system to the point (<parameter>x_coor</parameter>, - <parameter>y_coor</parameter>). &return.success; + Sets the origin of coordinate system to the specified point. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + &cpdf.pdf-document.description; + <varlistentry> + <term><parameter>x_coor</parameter></term> + <listitem> + <para> + The x-coordinate of the point + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y_coor</parameter></term> + <listitem> + <para> + The y-coordinate of the point + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; </para> - - &cpdf.ul; - </refsect1> </refentry>