From 1f7a574b809437fd45f0db152ff3664f542efce7 Mon Sep 17 00:00:00 2001
From: Mark Skilbeck <markskilbeck@php.net>
Date: Mon, 29 Mar 2010 20:48:54 +0000
Subject: [PATCH] Added Cairo documentation

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297109 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/cairo/cairosurface/construct.xml    | 30 ++------------
 reference/cairo/cairosurface/copypage.xml     |  7 +---
 .../cairo/cairosurface/createsimilar.xml      | 41 +++++++++++--------
 3 files changed, 30 insertions(+), 48 deletions(-)

diff --git a/reference/cairo/cairosurface/construct.xml b/reference/cairo/cairosurface/construct.xml
index 7f06305b98..46c5e4f813 100644
--- a/reference/cairo/cairosurface/construct.xml
+++ b/reference/cairo/cairosurface/construct.xml
@@ -14,11 +14,9 @@
    <void />
   </methodsynopsis>
   <para>
-   The method description goes here.
+   CairoSurface is an abstract type and, as such, should not be instantiated in your PHP scripts.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,29 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
-  </para>
- </refsect1>
-
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><methodname>CairoSurface::__construct</methodname> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
+   No return value
   </para>
  </refsect1>
 
@@ -59,7 +35,7 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>CairoImageSurface::__construct</methodname></member>
    </simplelist>
   </para>
  </refsect1>
diff --git a/reference/cairo/cairosurface/copypage.xml b/reference/cairo/cairosurface/copypage.xml
index b8d75022d7..023bc4e625 100644
--- a/reference/cairo/cairosurface/copypage.xml
+++ b/reference/cairo/cairosurface/copypage.xml
@@ -21,11 +21,8 @@
    <methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
   </methodsynopsis>
   <para>
-   Description here.
+   Emits the current page for backends that support multiple pages, but doesn't clear it, so that the contents of the current page will be retained for the next page. Use CairoSurface::showPage() if you want to get an empty page after the emission.
   </para>
-  
-  &warn.undocumented.func;
- 
  </refsect1>
 
  <refsect1 role="parameters">
@@ -36,7 +33,7 @@
      <term><parameter>context</parameter></term>
      <listitem>
       <para>
-       Description...
+       A CairoContext object
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/cairo/cairosurface/createsimilar.xml b/reference/cairo/cairosurface/createsimilar.xml
index 436809f99b..7462e4f3fc 100644
--- a/reference/cairo/cairosurface/createsimilar.xml
+++ b/reference/cairo/cairosurface/createsimilar.xml
@@ -6,32 +6,41 @@
   <refname>CairoSurface::createSimilar</refname>
   <refpurpose>The createSimilar purpose</refpurpose>
  </refnamediv>
-
+ 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>CairoSurface::createSimilar</methodname>
-   <methodparam><type>string</type><parameter>content</parameter></methodparam>
+   <methodparam><type>CairoSurface</type><parameter>other</parameter></methodparam>
+   <methodparam><type>int</type><parameter>content</parameter></methodparam>
    <methodparam><type>string</type><parameter>width</parameter></methodparam>
    <methodparam><type>string</type><parameter>height</parameter></methodparam>
   </methodsynopsis>
   <para>
-   The method description goes here.
+   Create a new surface that is as compatible as possible with an existing surface. For example the new surface will have the same fallback resolution and font options as other. Generally, the new surface will also use the same backend as other, unless that is not possible for some reason. The type of the returned surface may be examined with CairoSurface::getType().
+   
+   Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.)
   </para>
-
-  &warn.undocumented.func;
-
+  
  </refsect1>
-
+ 
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
    <variablelist>
+    <varlistentry>
+     <term><parameter>other</parameter></term>
+     <listitem>
+      <para>
+       An existing surface used to select the backend of the new surface
+      </para>
+     </listitem>
+    </varlistentry>
     <varlistentry>
      <term><parameter>content</parameter></term>
      <listitem>
       <para>
-       Description...
+       The content for the new surface. See the CairoContent class for possible values.
       </para>
      </listitem>
     </varlistentry>
@@ -39,7 +48,7 @@
      <term><parameter>width</parameter></term>
      <listitem>
       <para>
-       Description...
+       Width of the new surface, (in device-space units).
       </para>
      </listitem>
     </varlistentry>
@@ -47,21 +56,21 @@
      <term><parameter>height</parameter></term>
      <listitem>
       <para>
-       Description...
+       Height of the new surface, (in device-space units).
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
-
+ 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   A new CairoSurface
   </para>
  </refsect1>
-
+ 
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -83,16 +92,16 @@
    </example>
   </para>
  </refsect1>
-
+ 
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
+    <member><methodname>CairoContent</methodname></member>
    </simplelist>
   </para>
  </refsect1>
-
+ 
 </refentry>
 
 <!-- Keep this comment at the end of the file