[cairo-commit] 4 commits - doc/public src/cairo-recording-surface.c

[Carlos Garcia Campos]

 doc/public/cairo-docs.xml     |    1 +
 doc/public/cairo-sections.txt |    7 +++++++
 src/cairo-recording-surface.c |   30 ++++++++++++++++++++++++------
 3 files changed, 32 insertions(+), 6 deletions(-)

New commits:
commit 2b6c4c2a64c585cb815089e83719e00b1cfc985f
Author: Carlos Garcia Campos <carlosgc at gnome.org>
Date:   Thu Sep 9 11:28:03 2010 +0200

    recording: Document CAIRO_HAS_RECORDING_SURFACE macro

diff --git a/src/cairo-recording-surface.c b/src/cairo-recording-surface.c
index 211d662..79d51e8 100644
--- a/src/cairo-recording-surface.c
+++ b/src/cairo-recording-surface.c
@@ -90,6 +90,16 @@ typedef enum {
 
 static const cairo_surface_backend_t cairo_recording_surface_backend;
 
+/**
+ * CAIRO_HAS_RECORDING_SURFACE:
+ *
+ * Defined if the recording surface backend is available.
+ * The recording surface backend is always built in.
+ * This macro was added for completeness in cairo 1.10.
+ *
+ * Since: 1.10
+ */
+
 /* Currently all recording surfaces do have a size which should be passed
  * in as the maximum size of any target surface against which the
  * recording-surface will ever be replayed.
commit d8f88cf3f97af6771a4d77bf81e1025eb7bcfd1d
Author: Carlos Garcia Campos <carlosgc at gnome.org>
Date:   Thu Sep 9 11:00:42 2010 +0200

    recording: Fix cairo_recording_surface_create() doc comments
    
    The name of the parameters in the docs should match the name of the
    function parameters. Added also return value docs.

diff --git a/src/cairo-recording-surface.c b/src/cairo-recording-surface.c
index f814ed0..211d662 100644
--- a/src/cairo-recording-surface.c
+++ b/src/cairo-recording-surface.c
@@ -102,8 +102,8 @@ static const cairo_surface_backend_t cairo_recording_surface_backend;
 /**
  * cairo_recording_surface_create:
  * @content: the content of the recording surface
- * @extents_pixels: the extents to record in pixels, can be %NULL to record
- *                  unbounded operations.
+ * @extents: the extents to record in pixels, can be %NULL to record
+ *           unbounded operations.
  *
  * Creates a recording-surface which can be used to record all drawing operations
  * at the highest level (that is, the level of paint, mask, stroke, fill
@@ -114,7 +114,11 @@ static const cairo_surface_backend_t cairo_recording_surface_backend;
  * necessary objects (paths, patterns, etc.), in order to achieve
  * accurate replay.
  *
- * Since 1.10
+ * Return value: a pointer to the newly created surface. The caller
+ * owns the surface and should call cairo_surface_destroy() when done
+ * with it.
+ *
+ * Since: 1.10
  **/
 cairo_surface_t *
 cairo_recording_surface_create (cairo_content_t		 content,
commit 737880260f1895667baf25bcc6814052e6a6a027
Author: Carlos Garcia Campos <carlosgc at gnome.org>
Date:   Thu Sep 9 10:57:13 2010 +0200

    recording: Add section doc comments

diff --git a/src/cairo-recording-surface.c b/src/cairo-recording-surface.c
index f7c501c..f814ed0 100644
--- a/src/cairo-recording-surface.c
+++ b/src/cairo-recording-surface.c
@@ -37,7 +37,13 @@
  *	Adrian Johnson <ajohnson at redneon.com>
  */
 
-/* A recording surface is a surface that records all drawing operations at
+/**
+ * SECTION:cairo-recording
+ * @Title: Recording Surfaces
+ * @Short_Description: Records all drawing operations
+ * @See_Also: #cairo_surface_t
+ *
+ * A recording surface is a surface that records all drawing operations at
  * the highest level of the surface backend interface, (that is, the
  * level of paint, mask, stroke, fill, and show_text_glyphs). The recording
  * surface can then be "replayed" against any target surface by using it
@@ -70,8 +76,6 @@
  * copy-on-write implementation for _cairo_surface_snapshot.
  */
 
-/* XXX Rename to recording surface */
-
 #include "cairoint.h"
 #include "cairo-analysis-surface-private.h"
 #include "cairo-clip-private.h"
commit 1ddc1bfa01e4c17001504c886bc5fb97625f5861
Author: Carlos Garcia Campos <carlosgc at gnome.org>
Date:   Thu Sep 9 10:54:50 2010 +0200

    doc: Add section for recording surface

diff --git a/doc/public/cairo-docs.xml b/doc/public/cairo-docs.xml
index 2351f47..c2ffead 100644
--- a/doc/public/cairo-docs.xml
+++ b/doc/public/cairo-docs.xml
@@ -36,6 +36,7 @@
     <xi:include href="xml/cairo-pdf.xml"/>
     <xi:include href="xml/cairo-png.xml"/>
     <xi:include href="xml/cairo-ps.xml"/>
+    <xi:include href="xml/cairo-recording.xml"/>
     <xi:include href="xml/cairo-win32.xml"/>
     <!--xi:include href="xml/cairo-beos.xml"/-->
     <xi:include href="xml/cairo-svg.xml"/>
diff --git a/doc/public/cairo-sections.txt b/doc/public/cairo-sections.txt
index 8757366..88debec 100644
--- a/doc/public/cairo-sections.txt
+++ b/doc/public/cairo-sections.txt
@@ -102,6 +102,13 @@ cairo_ps_surface_dsc_comment
 </SECTION>
 
 <SECTION>
+<FILE>cairo-recording</FILE>
+CAIRO_HAS_RECORDING_SURFACE
+cairo_recording_surface_create
+cairo_recording_surface_ink_extents
+</SECTION>
+
+<SECTION>
 <FILE>cairo-win32</FILE>
 CAIRO_HAS_WIN32_SURFACE
 cairo_win32_surface_create