From babd60fe0f9845ca358ec2e3d4cc7abb8309aa18 Mon Sep 17 00:00:00 2001 From: Elizabeth Marie Smith Date: Mon, 5 Oct 2009 18:19:57 +0000 Subject: [PATCH] Some additional cleanup for cairo class, init methods for matrix documented, add scale method back in (we only wanted to remove the scale function file) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289228 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/cairo/cairo.xml | 2 +- reference/cairo/cairo/availablefonts.xml | 2 +- reference/cairo/cairo/statustostring.xml | 5 +- reference/cairo/cairo/version.xml | 1 - reference/cairo/cairo/versionstring.xml | 1 - reference/cairo/cairomatrix.xml | 2 +- reference/cairo/cairomatrix/construct.xml | 4 +- reference/cairo/cairomatrix/initidentity.xml | 42 ++++-- reference/cairo/cairomatrix/initrotate.xml | 47 +++++-- reference/cairo/cairomatrix/initscale.xml | 53 +++++--- reference/cairo/cairomatrix/inittranslate.xml | 50 ++++--- reference/cairo/cairomatrix/scale.xml | 126 ++++++++++++++++++ reference/cairo/configure.xml | 39 ------ .../functions/cairo-matrix-create-scale.xml | 94 +------------ .../cairo-matrix-create-translate.xml | 94 +------------ .../functions/cairo-matrix-init-identity.xml | 102 -------------- .../functions/cairo-matrix-init-rotate.xml | 113 ---------------- .../functions/cairo-matrix-init-scale.xml | 122 ----------------- .../functions/cairo-matrix-init-translate.xml | 122 ----------------- reference/cairo/versions.xml | 10 -- 20 files changed, 278 insertions(+), 753 deletions(-) create mode 100644 reference/cairo/cairomatrix/scale.xml delete mode 100644 reference/cairo/configure.xml delete mode 100644 reference/cairo/functions/cairo-matrix-init-identity.xml delete mode 100644 reference/cairo/functions/cairo-matrix-init-rotate.xml delete mode 100644 reference/cairo/functions/cairo-matrix-init-scale.xml delete mode 100644 reference/cairo/functions/cairo-matrix-init-translate.xml diff --git a/reference/cairo/cairo.xml b/reference/cairo/cairo.xml index ca6ba82952..6644c389f9 100644 --- a/reference/cairo/cairo.xml +++ b/reference/cairo/cairo.xml @@ -12,7 +12,7 @@
&reftitle.intro; - Description of the class. + Simple class with some static helper methods.
diff --git a/reference/cairo/cairo/availablefonts.xml b/reference/cairo/cairo/availablefonts.xml index 0b3b86af08..bdf6723545 100644 --- a/reference/cairo/cairo/availablefonts.xml +++ b/reference/cairo/cairo/availablefonts.xml @@ -5,7 +5,7 @@ Cairo::availableFonts cairo_available_fonts - Retrives the availables font types + Retrieves the availables font types diff --git a/reference/cairo/cairo/statustostring.xml b/reference/cairo/cairo/statustostring.xml index 6ad82692be..96c0480859 100644 --- a/reference/cairo/cairo/statustostring.xml +++ b/reference/cairo/cairo/statustostring.xml @@ -13,12 +13,12 @@ Object oriented style (method): public static voidCairo::statusToString - stringstatus + intstatus Procedural style: ReturnTypecairo_status_to_string - stringstatus + intstatus Retrieves the current status as a readable string @@ -100,7 +100,6 @@ string(7) "success" CairoContext::status - cairo_status diff --git a/reference/cairo/cairo/version.xml b/reference/cairo/cairo/version.xml index fec4713896..9891d15e10 100644 --- a/reference/cairo/cairo/version.xml +++ b/reference/cairo/cairo/version.xml @@ -83,7 +83,6 @@ int(10808) Cairo::versionString - cairo_version_string diff --git a/reference/cairo/cairo/versionstring.xml b/reference/cairo/cairo/versionstring.xml index 810cd88950..bcd0c9bb3f 100644 --- a/reference/cairo/cairo/versionstring.xml +++ b/reference/cairo/cairo/versionstring.xml @@ -87,7 +87,6 @@ string(5) "1.8.8" Cairo::version - cairo_version diff --git a/reference/cairo/cairomatrix.xml b/reference/cairo/cairomatrix.xml index a4cdc1c58f..70b53d0e94 100644 --- a/reference/cairo/cairomatrix.xml +++ b/reference/cairo/cairomatrix.xml @@ -12,7 +12,7 @@
&reftitle.intro; - Description of the class. + Matrices are used throughout cairo to convert between different coordinate spaces.
diff --git a/reference/cairo/cairomatrix/construct.xml b/reference/cairo/cairomatrix/construct.xml index 6566a4faad..7847a9bbbc 100644 --- a/reference/cairo/cairomatrix/construct.xml +++ b/reference/cairo/cairomatrix/construct.xml @@ -3,7 +3,7 @@ - CairoPattern::__construct + CairoMatrix::__construct cairo_matrix_init Creates a new CairoMatrix object @@ -22,7 +22,7 @@ Procedural style: - ReturnTypecairo_matrix_init + objectcairo_matrix_init floatxx floatyx floatxy diff --git a/reference/cairo/cairomatrix/initidentity.xml b/reference/cairo/cairomatrix/initidentity.xml index 8f4db3301c..a0fc7ea11f 100644 --- a/reference/cairo/cairomatrix/initidentity.xml +++ b/reference/cairo/cairomatrix/initidentity.xml @@ -4,21 +4,28 @@ CairoMatrix::initIdentity - The initIdentity purpose + cairo_matrix_init_identity + Creates a new identity matrix &reftitle.description; + Object oriented style (method): public static voidCairoMatrix::initIdentity + Procedural style: + + objectcairo_matrix_init_identity + + - The method description goes here. + Creates a new matrix that is an identity transformation. An identity + transformation means the source data is copied into the destination data + without change - &warn.undocumented.func; - @@ -29,7 +36,7 @@ &reftitle.returnvalues; - Description... + Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. @@ -37,20 +44,28 @@ &reftitle.examples; - <methodname>CairoMatrix::initIdentity</methodname> example + Object oriented style ]]> - &example.outputs.similar; - + + + + + Procedural style + ]]> - + @@ -59,7 +74,10 @@ &reftitle.seealso; - Classname::Method + CairoMatrix::__construct + CairoMatrix::initRotate + CairoMatrix::initScale + CairoMatrix::initTranslate diff --git a/reference/cairo/cairomatrix/initrotate.xml b/reference/cairo/cairomatrix/initrotate.xml index abea9f2973..93572069ac 100644 --- a/reference/cairo/cairomatrix/initrotate.xml +++ b/reference/cairo/cairomatrix/initrotate.xml @@ -4,21 +4,26 @@ CairoMatrix::initRotate - The initRotate purpose + cairo_matrix_init_rotate + Creates a new rotated matrix &reftitle.description; + Object oriented style (method): public static voidCairoMatrix::initRotate - stringradians + floatradians + + Procedural style: + + objectcairo_matrix_init_rotate + floatradians - The method description goes here. + Creats a new matrix to a transformation that rotates by radians provided - &warn.undocumented.func; - @@ -29,7 +34,10 @@ radians - Description... + angle of rotation, in radians. The direction of rotation is defined such + that positive angles rotate in the direction from the positive X axis + toward the positive Y axis. With the default axis orientation of cairo, + positive angles rotate in a clockwise direction. @@ -40,7 +48,7 @@ &reftitle.returnvalues; - Description... + Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. @@ -48,20 +56,28 @@ &reftitle.examples; - <methodname>CairoMatrix::initRotate</methodname> example + Object oriented style ]]> - &example.outputs.similar; - + + + + + Procedural style + ]]> - + @@ -70,7 +86,10 @@ &reftitle.seealso; - Classname::Method + CairoMatrix::__construct + CairoMatrix::initIdentity + CairoMatrix::initScale + CairoMatrix::initTranslate diff --git a/reference/cairo/cairomatrix/initscale.xml b/reference/cairo/cairomatrix/initscale.xml index e1d576ea2b..010024a8a5 100644 --- a/reference/cairo/cairomatrix/initscale.xml +++ b/reference/cairo/cairomatrix/initscale.xml @@ -4,24 +4,32 @@ CairoMatrix::initScale - The initScale purpose + cairo_matrix_init_scale + cairo_matrix_create_scale + Creates a new scaling matrix &reftitle.description; + Object oriented style (method): public static voidCairoMatrix::initScale - stringsx - stringsy + floatsx + floatsy + + Procedural style: + + objectcairo_matrix_init_scale + floatsx + floatsy - The method description goes here. + Creates a new matrix to a transformation that scales by sx and sy in the X + and Y dimensions, respectively. - &warn.undocumented.func; - - + &reftitle.parameters; @@ -30,7 +38,7 @@ sx - Description... + scale factor in the X direction @@ -38,7 +46,7 @@ sy - Description... + scale factor in the Y direction @@ -49,7 +57,7 @@ &reftitle.returnvalues; - Description... + Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. @@ -57,20 +65,28 @@ &reftitle.examples; - <methodname>CairoMatrix::initScale</methodname> example + Object oriented style ]]> - &example.outputs.similar; - + + + + + Procedural style + ]]> - + @@ -79,7 +95,10 @@ &reftitle.seealso; - Classname::Method + CairoMatrix::__construct + CairoMatrix::initIdentity + CairoMatrix::initRotate + CairoMatrix::initTranslate diff --git a/reference/cairo/cairomatrix/inittranslate.xml b/reference/cairo/cairomatrix/inittranslate.xml index 23ad356e1c..973ef934d0 100644 --- a/reference/cairo/cairomatrix/inittranslate.xml +++ b/reference/cairo/cairomatrix/inittranslate.xml @@ -4,22 +4,29 @@ CairoMatrix::initTranslate - The initTranslate purpose + cairo_matrix_init_translate + Creates a new translation matrix &reftitle.description; + Object oriented style (method): public static voidCairoMatrix::initTranslate - stringtx - stringty + floattx + floatty + + Procedural style: + + objectcairo_matrix_init_translate + floattx + floatty - The method description goes here. + Creates a new matrix to a transformation that translates by tx and ty in the X + and Y dimensions, respectively. - &warn.undocumented.func; - @@ -30,7 +37,7 @@ tx - Description... + amount to translate in the X direction @@ -38,7 +45,7 @@ ty - Description... + amount to translate in the Y direction @@ -49,7 +56,7 @@ &reftitle.returnvalues; - Description... + Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. @@ -57,20 +64,28 @@ &reftitle.examples; - <methodname>CairoMatrix::initTranslate</methodname> example + Object oriented style ]]> - &example.outputs.similar; - + + + + + Procedural style + ]]> - + @@ -79,7 +94,10 @@ &reftitle.seealso; - Classname::Method + CairoMatrix::__construct + CairoMatrix::initIdentity + CairoMatrix::initRotate + CairoMatrix::initScale diff --git a/reference/cairo/cairomatrix/scale.xml b/reference/cairo/cairomatrix/scale.xml new file mode 100644 index 0000000000..094d3e6c66 --- /dev/null +++ b/reference/cairo/cairomatrix/scale.xml @@ -0,0 +1,126 @@ + + + + + + CairoMatrix::scale + cairo_matrix_scale + Applies scaling to a matrix + + + + &reftitle.description; + Object oriented style (method): + + public voidCairoMatrix::scale + floatsx + floatsy + + Procedural style: + + voidcairo_matrix_scale + CairoContextcontext + floatsx + floatsy + + + 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. + + + + + + &reftitle.parameters; + + + + matrix + + + Procedural only - CairoMatrix instance + + + + + sx + + + scale factor in the X direction + + + + + sy + + + scale factor in the Y direction + + + + + + + + + &reftitle.examples; + + + Object oriented style + +scale(0.2, 2.0); +?> +]]> + + + + + Procedural style + + +]]> + + + + + + &reftitle.seealso; + + + CairoMatrix::initScale + + + + + + + diff --git a/reference/cairo/configure.xml b/reference/cairo/configure.xml deleted file mode 100644 index 229a49a96d..0000000000 --- a/reference/cairo/configure.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;cairo - - - - The latest PECL/cairo Win32 DLL is available here: - php_cairo.dll - - -
- - - diff --git a/reference/cairo/functions/cairo-matrix-create-scale.xml b/reference/cairo/functions/cairo-matrix-create-scale.xml index 4b6a8ad344..3c072617a8 100644 --- a/reference/cairo/functions/cairo-matrix-create-scale.xml +++ b/reference/cairo/functions/cairo-matrix-create-scale.xml @@ -4,98 +4,16 @@ cairo_matrix_create_scale - Description + &Alias; CairoMatrix::initScale &reftitle.description; - - ReturnTypecairo_matrix_create_scale - stringsx - stringsy - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - sx - - - Description... - - - - - sy - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_create_scale</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - + + &info.function.alias; + CairoMatrix::initScale. + + &info.function.alias.deprecated; diff --git a/reference/cairo/functions/cairo-matrix-create-translate.xml b/reference/cairo/functions/cairo-matrix-create-translate.xml index ff80ce2014..a657cbff7c 100644 --- a/reference/cairo/functions/cairo-matrix-create-translate.xml +++ b/reference/cairo/functions/cairo-matrix-create-translate.xml @@ -4,98 +4,16 @@ cairo_matrix_create_translate - Description + &Alias; CairoMatrix::initTranslate &reftitle.description; - - ReturnTypecairo_matrix_create_translate - stringtx - stringty - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - tx - - - Description... - - - - - ty - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_create_translate</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - + + &info.function.alias; + CairoMatrix::initTranslate. + + &info.function.alias.deprecated; diff --git a/reference/cairo/functions/cairo-matrix-init-identity.xml b/reference/cairo/functions/cairo-matrix-init-identity.xml deleted file mode 100644 index 2c487fc137..0000000000 --- a/reference/cairo/functions/cairo-matrix-init-identity.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - cairo_matrix_init_identity - Description - - - - &reftitle.description; - - ReturnTypecairo_matrix_init_identity - - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_init_identity</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-init-rotate.xml b/reference/cairo/functions/cairo-matrix-init-rotate.xml deleted file mode 100644 index f0a78b6730..0000000000 --- a/reference/cairo/functions/cairo-matrix-init-rotate.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_matrix_init_rotate - Description - - - - &reftitle.description; - - ReturnTypecairo_matrix_init_rotate - stringradians - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - radians - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_init_rotate</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-init-scale.xml b/reference/cairo/functions/cairo-matrix-init-scale.xml deleted file mode 100644 index 2fefddf946..0000000000 --- a/reference/cairo/functions/cairo-matrix-init-scale.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_matrix_init_scale - Description - - - - &reftitle.description; - - ReturnTypecairo_matrix_init_scale - stringsx - stringsy - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - sx - - - Description... - - - - - sy - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_init_scale</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-init-translate.xml b/reference/cairo/functions/cairo-matrix-init-translate.xml deleted file mode 100644 index 2bfa46c601..0000000000 --- a/reference/cairo/functions/cairo-matrix-init-translate.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_matrix_init_translate - Description - - - - &reftitle.description; - - ReturnTypecairo_matrix_init_translate - stringtx - stringty - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - tx - - - Description... - - - - - ty - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_init_translate</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/versions.xml b/reference/cairo/versions.xml index 35ee145e88..3cc442f332 100644 --- a/reference/cairo/versions.xml +++ b/reference/cairo/versions.xml @@ -11,11 +11,6 @@ Example entries: --> - - - - - @@ -134,11 +129,6 @@ Example entries: - - - - -