From b3329266083b382eb885edb592247d9b35aaa79f Mon Sep 17 00:00:00 2001 From: Elizabeth Marie Smith <auroraeosrose@php.net> Date: Thu, 1 Oct 2009 17:42:16 +0000 Subject: [PATCH] Typo fixes and some matrix docs git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289059 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/cairo/cairo/availablefonts.xml | 6 +- reference/cairo/cairo/availablesurfaces.xml | 4 +- reference/cairo/cairo/version.xml | 4 +- reference/cairo/cairo/versionstring.xml | 4 +- reference/cairo/cairomatrix/construct.xml | 83 ++++++++++++++------- reference/cairo/cairomatrix/scale.xml | 75 ++++++------------- 6 files changed, 88 insertions(+), 88 deletions(-) diff --git a/reference/cairo/cairo/availablefonts.xml b/reference/cairo/cairo/availablefonts.xml index 72ba3abb92..0b3b86af08 100644 --- a/reference/cairo/cairo/availablefonts.xml +++ b/reference/cairo/cairo/availablefonts.xml @@ -5,7 +5,7 @@ <refnamediv> <refname>Cairo::availableFonts</refname> <refname>cairo_available_fonts</refname> - <refpurpose>Retrives the availables fonts types</refpurpose> + <refpurpose>Retrives the availables font types</refpurpose> </refnamediv> <refsect1 role="description"> @@ -21,7 +21,7 @@ <void /> </methodsynopsis> <para> - Returns an array with the available fonts backends + Returns an array with the available font backends </para> </refsect1> @@ -34,7 +34,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - A list-type array with all available fonts backends. + A list-type array with all available font backends. </para> </refsect1> diff --git a/reference/cairo/cairo/availablesurfaces.xml b/reference/cairo/cairo/availablesurfaces.xml index 66f969fdf6..1c8312817a 100644 --- a/reference/cairo/cairo/availablesurfaces.xml +++ b/reference/cairo/cairo/availablesurfaces.xml @@ -21,7 +21,7 @@ <void /> </methodsynopsis> <para> - Returns an array with the available surfaces backends + Returns an array with the available surface backends </para> </refsect1> @@ -34,7 +34,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - A list-type array with all available surfaces backends. + A list-type array with all available surface backends. </para> </refsect1> diff --git a/reference/cairo/cairo/version.xml b/reference/cairo/cairo/version.xml index 5e856d77c0..fec4713896 100644 --- a/reference/cairo/cairo/version.xml +++ b/reference/cairo/cairo/version.xml @@ -21,7 +21,7 @@ <void /> </methodsynopsis> <para> - Retrieves the current version of the cairo library + Retrieves the current version of the cairo library as an integer value </para> </refsect1> @@ -34,7 +34,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the version of the current cairo library + Current Cairo library version integer </para> </refsect1> diff --git a/reference/cairo/cairo/versionstring.xml b/reference/cairo/cairo/versionstring.xml index 54bbfbfef1..810cd88950 100644 --- a/reference/cairo/cairo/versionstring.xml +++ b/reference/cairo/cairo/versionstring.xml @@ -21,7 +21,7 @@ <void /> </methodsynopsis> <para> - Retrieves the current cairo library version as string. + Retrieves the current cairo library version as a string. </para> </refsect1> @@ -34,7 +34,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns a string represented version + Current Cairo library version string </para> </refsect1> diff --git a/reference/cairo/cairomatrix/construct.xml b/reference/cairo/cairomatrix/construct.xml index c0ad1847e7..6566a4faad 100644 --- a/reference/cairo/cairomatrix/construct.xml +++ b/reference/cairo/cairomatrix/construct.xml @@ -3,37 +3,58 @@ <refentry xml:id="cairomatrix.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> - <refname>CairoMatrix::__construct</refname> - <refpurpose>The __construct purpose</refpurpose> + <refname>CairoPattern::__construct</refname> + <refname>cairo_matrix_init</refname> + <refpurpose>Creates a new CairoMatrix object</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; + <para>Object oriented style (method):</para> <methodsynopsis> <methodname>CairoMatrix::__construct</methodname> - <methodparam choice="opt"><type>string</type><parameter>yx</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>xy</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>yy</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>x0</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>y0</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>xx</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>yx</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>xy</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>yy</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>x0</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>y0</parameter></methodparam> + </methodsynopsis> + <para>Procedural style:</para> + <methodsynopsis> + <type>ReturnType</type><methodname>cairo_matrix_init</methodname> + <methodparam choice="opt"><type>float</type><parameter>xx</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>yx</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>xy</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>yy</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>x0</parameter></methodparam> + <methodparam choice="opt"><type>float</type><parameter>y0</parameter></methodparam> </methodsynopsis> <para> - The method description goes here. + Returns new CairoMatrix object. Matrices are used throughout cairo to convert between different coordinate spaces. + Sets matrix to be the affine transformation given by xx, yx, xy, yy, x0, y0. The transformation is given by: + x_new = xx * x + xy * y + x0; and y_new = yx * x + yy * y + y0; </para> - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> + <varlistentry> + <term><parameter>xx</parameter></term> + <listitem> + <para> + xx component of the affine transformation + </para> + </listitem> + </varlistentry> <varlistentry> <term><parameter>yx</parameter></term> <listitem> <para> - Description... + yx component of the affine transformation </para> </listitem> </varlistentry> @@ -41,7 +62,7 @@ <term><parameter>xy</parameter></term> <listitem> <para> - Description... + xy component of the affine transformation </para> </listitem> </varlistentry> @@ -49,7 +70,7 @@ <term><parameter>yy</parameter></term> <listitem> <para> - Description... + yy component of the affine transformation </para> </listitem> </varlistentry> @@ -57,7 +78,7 @@ <term><parameter>x0</parameter></term> <listitem> <para> - Description... + X translation component of the affine transformation </para> </listitem> </varlistentry> @@ -65,7 +86,7 @@ <term><parameter>y0</parameter></term> <listitem> <para> - Description... + Y translation component of the affine transformation </para> </listitem> </varlistentry> @@ -76,37 +97,49 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Description... + Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. </para> </refsect1> - <refsect1 role="examples"> +<refsect1 role="examples"> &reftitle.examples; <para> <example> - <title><methodname>CairoMatrix::__construct</methodname> example</title> + <title>Object oriented style</title> <programlisting role="php"> <![CDATA[ <?php -/* ... */ +/* Create a new Matrix */ +$matrix = new CairoMatrix(1.0, 0.5, 0.0, 1.0, 0.0, 0.0); ?> ]]> - </programlisting> - &example.outputs.similar; - <screen> + </programlisting> + </example> + </para> + <para> + <example> + <title>Procedural style</title> + <programlisting role="php"> <![CDATA[ -... +<?php +/* Create a new Matrix */ +$matrix = cairo_matrix_init(1.0, 0.5, 0.0, 1.0, 0.0, 0.0); +?> ]]> - </screen> + </programlisting> </example> </para> </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><methodname>Classname::Method</methodname></member> + <member><methodname>CairoMatrix::initIdentity</methodname></member> + <member><methodname>CairoMatrix::initRotate</methodname></member> + <member><methodname>CairoMatrix::initScale</methodname></member> + <member><methodname>CairoMatrix::initTranslate</methodname></member> </simplelist> </para> </refsect1> diff --git a/reference/cairo/cairomatrix/scale.xml b/reference/cairo/cairomatrix/scale.xml index a9ca4c42b0..5e203c1d33 100644 --- a/reference/cairo/cairomatrix/scale.xml +++ b/reference/cairo/cairomatrix/scale.xml @@ -4,8 +4,8 @@ <refentry xml:id="cairomatrix.scale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> <refname>CairoMatrix::scale</refname> - <refname>cairo_scale</refname> - <refpurpose>The scale purpose</refpurpose> + <refname>cairo_matrix_scale</refname> + <refpurpose>Applies scaling to a matrix</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,21 +13,21 @@ <para>Object oriented style (method):</para> <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>CairoMatrix::scale</methodname> - <methodparam><type>string</type><parameter>sx</parameter></methodparam> - <methodparam><type>string</type><parameter>sy</parameter></methodparam> + <methodparam><type>float</type><parameter>sx</parameter></methodparam> + <methodparam><type>float</type><parameter>sy</parameter></methodparam> </methodsynopsis> <para>Procedural style:</para> <methodsynopsis> - <type>ReturnType</type><methodname>cairo_scale</methodname> + <type>ReturnType</type><methodname>cairo_matrix_scale</methodname> <methodparam><type>CairoContext</type><parameter>context</parameter></methodparam> - <methodparam><type>string</type><parameter>x</parameter></methodparam> - <methodparam><type>string</type><parameter>y</parameter></methodparam> + <methodparam><type>float</type><parameter>sx</parameter></methodparam> + <methodparam><type>float</type><parameter>sy</parameter></methodparam> </methodsynopsis> <para> - Description here. + Applies scaling by sx, sy to the transformation in the matrix. The effect of + the new transformation is to first scale the coordinates by sx and sy, then + apply the original transformation to the coordinates. </para> - - &warn.undocumented.func; </refsect1> @@ -36,26 +36,10 @@ <para> <variablelist> <varlistentry> - <term><parameter>context</parameter></term> + <term><parameter>matrix</parameter></term> <listitem> <para> - Description... - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - Description... - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - Description... + Procedural only - CairoMatrix instance </para> </listitem> </varlistentry> @@ -63,7 +47,7 @@ <term><parameter>sx</parameter></term> <listitem> <para> - Description... + scale factor in the X direction </para> </listitem> </varlistentry> @@ -71,7 +55,7 @@ <term><parameter>sy</parameter></term> <listitem> <para> - Description... + scale factor in the Y direction </para> </listitem> </varlistentry> @@ -79,13 +63,6 @@ </para> </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Description... - </para> - </refsect1> - <refsect1 role="examples"> &reftitle.examples; <para> @@ -94,17 +71,12 @@ <programlisting role="php"> <![CDATA[ <?php -/* ... */ +/* Apply scaling to a matrix */ +$matrix = new CairoMatrix(1.0, 0.5, 0.0, 1.0, 0.0, 0.0); +$matrix->scale(0.2, 2.0); ?> ]]> </programlisting> - &example.outputs.similar; - <screen> -<![CDATA[ -... -]]> - </screen> - </example> </para> <para> <example> @@ -112,17 +84,12 @@ <programlisting role="php"> <![CDATA[ <?php -/* ... */ +/* Apply scaling to a matrix */ +$matrix = cairo_matrix_init(1.0, 0.5, 0.0, 1.0, 0.0, 0.0); +cairo_matrix_scale($matrix, 0.2, 2.0); ?> ]]> </programlisting> - &example.outputs.similar; - <screen> -<![CDATA[ -... -]]> - </screen> - </example> </para> </refsect1> @@ -130,7 +97,7 @@ &reftitle.seealso; <para> <simplelist> - <member><methodname>Classname::Method</methodname></member> + <member><methodname>CairoMatrix::initScale</methodname></member> </simplelist> </para> </refsect1>