[PATCHES] documentation update

From 728c16a54f6b4c813cb32043ed05ee5204585e13 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 20:28:47 +0100
Subject: [PATCH 01/25] doc: add missing colons to since tags

---
 src/cairo-ft-font.c |   12 ++++++------
 src/cairo-ft.h      |    2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c
index af66de0..d3c4514 100644
--- a/src/cairo-ft-font.c
+++ b/src/cairo-ft-font.c
@@ -3267,8 +3267,8 @@ cairo_ft_font_face_create_for_ft_face (FT_Face         face,
  * font, which is useful if you lack those glyphs from a true bold or oblique
  * font.
  *
- * Since 1.12.
- */
+ * Since: 1.12
+ **/
 void
 cairo_ft_font_face_set_synthesize (cairo_font_face_t *font_face,
 				   unsigned int synth_flags)
@@ -3289,8 +3289,8 @@ cairo_ft_font_face_set_synthesize (cairo_font_face_t *font_face,
  *
  * See cairo_ft_font_face_set_synthesize().
  *
- * Since 1.12.
- */
+ * Since: 1.12
+ **/
 void
 cairo_ft_font_face_unset_synthesize (cairo_font_face_t *font_face,
 				     unsigned int synth_flags)
@@ -3310,8 +3310,8 @@ cairo_ft_font_face_unset_synthesize (cairo_font_face_t *font_face,
  *
  * Returns the current set of synthesis options.
  *
- * Since 1.12.
- */
+ * Since: 1.12
+ **/
 unsigned int
 cairo_ft_font_face_get_synthesize (cairo_font_face_t *font_face)
 {
diff --git a/src/cairo-ft.h b/src/cairo-ft.h
index 90fea31..1006727 100644
--- a/src/cairo-ft.h
+++ b/src/cairo-ft.h
@@ -74,7 +74,7 @@ cairo_ft_font_face_create_for_ft_face (FT_Face         face,
  * @CAIRO_FT_SYNTHESIZE_OBLIQUE: Slant the glyph outline by 12 degrees to the
  * right.
  *
- * Since 1.12.
+ * Since: 1.12
  **/
 typedef enum {
     CAIRO_FT_SYNTHESIZE_BOLD = 1 << 0,
-- 
1.7.2.5

From b053c01594895f832c645f5085c92114c1768784 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 20:31:12 +0100
Subject: [PATCH 02/25] doc: typo

---
 src/cairo-pattern.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/src/cairo-pattern.c b/src/cairo-pattern.c
index f114ca8..eaf3c57 100644
--- a/src/cairo-pattern.c
+++ b/src/cairo-pattern.c
@@ -1544,7 +1544,7 @@ slim_hidden_def (cairo_mesh_pattern_line_to);
  * Note: If @pattern is not a mesh pattern then @pattern will be put
  * into an error status with a status of
  * %CAIRO_STATUS_PATTERN_TYPE_MISMATCH. If @pattern has no current
- * patch or the current patch already has at leas one side, @pattern
+ * patch or the current patch already has at least one side, @pattern
  * will be put into an error status with a status of
  * %CAIRO_STATUS_INVALID_MESH_CONSTRUCTION.
  *
-- 
1.7.2.5

From 0bfa6ca272c923c4790d068f478e9342307d1b1f Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 20:45:05 +0100
Subject: [PATCH 03/25] doc: add index of new symbols in 1.12

---
 doc/public/cairo-docs.xml |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

diff --git a/doc/public/cairo-docs.xml b/doc/public/cairo-docs.xml
index f67f3e9..b2182f1 100644
--- a/doc/public/cairo-docs.xml
+++ b/doc/public/cairo-docs.xml
@@ -70,5 +70,8 @@
   <index id="index-1.10" role="1.10">
     <title>Index of new symbols in 1.10</title>
   </index>
+  <index id="index-1.12" role="1.12">
+    <title>Index of new symbols in 1.12</title>
+  </index>
   <xi:include href="language-bindings.xml"/>
 </book>
-- 
1.7.2.5

From b07e223060301f35c434d021547d78e92ebbbe86 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 21:38:39 +0100
Subject: [PATCH 04/25] doc: add colon to .._padded_image_from_image

---
 src/cairo-ps-surface.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/src/cairo-ps-surface.c b/src/cairo-ps-surface.c
index 043d016..e22e2cc 100644
--- a/src/cairo-ps-surface.c
+++ b/src/cairo-ps-surface.c
@@ -1782,7 +1782,7 @@ _cairo_ps_surface_release_source_surface_from_pattern (cairo_ps_surface_t
 }
 
 /**
- * _cairo_ps_surface_create_padded_image_from_image
+ * _cairo_ps_surface_create_padded_image_from_image:
  * @surface: the ps surface
  * @source: The source image
  * @extents: extents of the operation that is using this source
-- 
1.7.2.5

From 64906bdfedb370c60455f241f907e0f34621ada8 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 21:43:27 +0100
Subject: [PATCH 05/25] doc: add missing _face to function names

---
 src/cairo-ft-font.c |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c
index d3c4514..34cf109 100644
--- a/src/cairo-ft-font.c
+++ b/src/cairo-ft-font.c
@@ -3259,7 +3259,7 @@ cairo_ft_font_face_create_for_ft_face (FT_Face         face,
 }
 
 /**
- * cairo_ft_font_set_synthesize:
+ * cairo_ft_font_face_set_synthesize:
  * @font_face: The #cairo_ft_font_face_t object to modify
  * @synth_flags: the set of synthesis options to enable
  *
@@ -3283,7 +3283,7 @@ cairo_ft_font_face_set_synthesize (cairo_font_face_t *font_face,
 }
 
 /**
- * cairo_ft_font_unset_synthesize:
+ * cairo_ft_font_face_unset_synthesize:
  * @font_face: The #cairo_ft_font_face_t object to modify
  * @synth_flags: the set of synthesis options to disable
  *
@@ -3305,7 +3305,7 @@ cairo_ft_font_face_unset_synthesize (cairo_font_face_t *font_face,
 }
 
 /**
- * cairo_ft_font_get_synthesize:
+ * cairo_ft_font_face_get_synthesize:
  * @font_face: The #cairo_ft_font_face_t object to query
  *
  * Returns the current set of synthesis options.
-- 
1.7.2.5

From 859168c07d4cd49cf88dd1e974bb91d257b19c53 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 22:06:33 +0100
Subject: [PATCH 06/25] doc: do not confuse gtk-doc by @ and double *

---
 src/cairo-gl.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/cairo-gl.h b/src/cairo-gl.h
index d23b8a5..fb8f7fb 100644
--- a/src/cairo-gl.h
+++ b/src/cairo-gl.h
@@ -31,8 +31,8 @@
  * The Initial Developer of the Original Code is Eric Anholt.
  */
 
-/**
- * @file cairo-gl.h
+/*
+ * cairo-gl.h:
  *
  * The cairo-gl backend provides an implementation of possibly
  * hardware-accelerated cairo rendering by targeting the OpenGL API.
-- 
1.7.2.5

From f24b7be7a045f89d4e72a51087632bb4773971d2 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 22:06:56 +0100
Subject: [PATCH 07/25] doc: Add colon to Returns statement

---
 src/cairo-ft-font.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c
index 34cf109..e744481 100644
--- a/src/cairo-ft-font.c
+++ b/src/cairo-ft-font.c
@@ -3308,7 +3308,7 @@ cairo_ft_font_face_unset_synthesize (cairo_font_face_t *font_face,
  * cairo_ft_font_face_get_synthesize:
  * @font_face: The #cairo_ft_font_face_t object to query
  *
- * Returns the current set of synthesis options.
+ * Returns: the current set of synthesis options.
  *
  * Since: 1.12
  **/
-- 
1.7.2.5

From 90d8c907bc138ffc514bd00d1ab94eb0154204f3 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 17:46:10 +0100
Subject: [PATCH 08/25] doc: script_mode_t needs at least one line of text

Gtk-doc recognizes documentation only if there is additional text.
---
 src/cairo-script.h |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/src/cairo-script.h b/src/cairo-script.h
index 9151b06..371b29a 100644
--- a/src/cairo-script.h
+++ b/src/cairo-script.h
@@ -47,7 +47,9 @@ CAIRO_BEGIN_DECLS
  * @CAIRO_SCRIPT_MODE_ASCII: the output will be in readable text (default)
  * @CAIRO_SCRIPT_MODE_BINARY: the output will use byte codes
  *
- * Since 1.10
+ * A set of script output variants.
+ *
+ * Since: 1.10
  **/
 typedef enum {
     CAIRO_SCRIPT_MODE_ASCII,
-- 
1.7.2.5

From 4c10cb636dcd96f74cd20ba9ae9ed631373eacc9 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 23:00:54 +0100
Subject: [PATCH 09/25] doc: fix a few typos found by codespell

---
 perf/README                           |    4 ++--
 src/cairo-beos-surface.cpp            |    2 +-
 src/cairo-cogl-context.c              |    2 +-
 src/cairo-cogl-surface.c              |    4 ++--
 src/cairo-ft-font.c                   |    2 +-
 src/cairo-mesh-pattern-rasterizer.c   |    2 +-
 src/cairo-os2-surface.c               |    2 +-
 src/cairo-region.c                    |    2 +-
 src/cairo-types-private.h             |    2 +-
 src/cairo-wideint-private.h           |    2 +-
 src/cairo-xcb-shm.c                   |    2 +-
 src/cairo.c                           |    2 +-
 src/drm/cairo-drm-intel-brw-eu-emit.c |    2 +-
 src/win32/cairo-win32-font.c          |    2 +-
 test/Makefile.am                      |    2 +-
 test/README                           |    2 +-
 test/dash-offset.c                    |    2 +-
 test/glyph-cache-pressure.c           |    2 +-
 util/cairo-trace/cairo-trace.in       |    2 +-
 19 files changed, 21 insertions(+), 21 deletions(-)

diff --git a/perf/README b/perf/README
index 42a6148..beca927 100644
--- a/perf/README
+++ b/perf/README
@@ -92,7 +92,7 @@ cairo-perf-diff:
 
 As a convenience, this common desire to measure a single commit is
 supported by passing a single revision to cairo-perf-diff, in which
-case it will compare it to the immediately preceeding commit. So for
+case it will compare it to the immediately preceding commit. So for
 example:
 
     # Measure the impact of the latest commit
@@ -117,7 +117,7 @@ what has been cached:
 
 And finally, the -f mode is most useful in conjunction with the --
 option to cairo-perf-diff which allows you to pass options to the
-underlying cairo-perf runs. This allows you to restrict the additonal
+underlying cairo-perf runs. This allows you to restrict the additional
 test runs to a limited subset of the tests.
 
 For example, a frequently used trick is to first generate a chart with
diff --git a/src/cairo-beos-surface.cpp b/src/cairo-beos-surface.cpp
index 2e0f42c..2d96778 100644
--- a/src/cairo-beos-surface.cpp
+++ b/src/cairo-beos-surface.cpp
@@ -318,7 +318,7 @@ _cairo_beos_surface_set_clip_region (cairo_beos_surface_t *surface,
 	cairo_rectangle_int_t rect;
 
 	cairo_region_get_rectangle (region, i, &rect);
-	// Have to substract one, because for pixman, the second coordinate
+	// Have to subtract one, because for pixman, the second coordinate
 	// lies outside the rectangle.
 	bregion.Include (_cairo_rectangle_to_brect (&rect));
     }
diff --git a/src/cairo-cogl-context.c b/src/cairo-cogl-context.c
index 17e2d7e..0116b0a 100644
--- a/src/cairo-cogl-context.c
+++ b/src/cairo-cogl-context.c
@@ -99,7 +99,7 @@ _cairo_cogl_context_rectangle_real (cairo_cogl_context_t *cr,
  * before continuing to append their operations.
  *
  * In addition to the speculative store cairo-cogl also has a fast-path
- * fill_rectangle drawing operation that futher aims to minimize the cost
+ * fill_rectangle drawing operation that further aims to minimize the cost
  * of drawing rectangles.
  */
 static cairo_status_t
diff --git a/src/cairo-cogl-surface.c b/src/cairo-cogl-surface.c
index 7326284..155dcbc 100644
--- a/src/cairo-cogl-surface.c
+++ b/src/cairo-cogl-surface.c
@@ -1117,7 +1117,7 @@ _cairo_cogl_surface_clear (cairo_cogl_surface_t *surface,
      *
      * The main concern is that we want to avoid re-loading an external z
      * buffer at the start of each frame, but also many gpu architectures have
-     * optmizations for how they handle the depth/stencil buffers and can get
+     * optimizations for how they handle the depth/stencil buffers and can get
      * upset if they aren't cleared together at the start of the frame.
      *
      * FIXME: we need a way to assert that the clip stack currently isn't
@@ -2425,7 +2425,7 @@ _cairo_cogl_surface_fill_rectangle (void		     *abstract_surface,
 	return CAIRO_INT_STATUS_UNSUPPORTED;
 
     /* TODO:
-     * We need to aquire the textures here, look at the corresponding
+     * We need to acquire the textures here, look at the corresponding
      * attributes and see if this can be trivially handled by logging
      * a textured rectangle only needing simple scaling or translation
      * of texture coordinates.
diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c
index e744481..32a5870 100644
--- a/src/cairo-ft-font.c
+++ b/src/cairo-ft-font.c
@@ -3158,7 +3158,7 @@ FREE_PATTERN:
  * If the FC_FT_FACE element of @pattern is set, the user is responsible
  * for making sure that the referenced FT_Face remains valid for the life
  * time of the returned #cairo_font_face_t.  See
- * cairo_ft_font_face_create_for_ft_face() for an exmaple of how to couple
+ * cairo_ft_font_face_create_for_ft_face() for an example of how to couple
  * the life time of the FT_Face to that of the cairo font-face.
  *
  * Return value: a newly created #cairo_font_face_t. Free with
diff --git a/src/cairo-mesh-pattern-rasterizer.c b/src/cairo-mesh-pattern-rasterizer.c
index 82b16e7..6f0dd66 100644
--- a/src/cairo-mesh-pattern-rasterizer.c
+++ b/src/cairo-mesh-pattern-rasterizer.c
@@ -333,7 +333,7 @@ fd_fixed_fwd (int32_t f[4])
  *
  *  max(|B'(t)|) <= 3 max (|p1-p0|, |p2-p0|/2, |p3-p1|/2, |p3-p2|)
  *
- * So, to guarantee a maximum step lenght of 1/sqrt(2) we must do:
+ * So, to guarantee a maximum step length of 1/sqrt(2) we must do:
  *
  *   3 max (|p1-p0|, |p2-p0|/2, |p3-p1|/2, |p3-p2|) sqrt(2) steps
  */
diff --git a/src/cairo-os2-surface.c b/src/cairo-os2-surface.c
index 3b83d0f..19646fb 100644
--- a/src/cairo-os2-surface.c
+++ b/src/cairo-os2-surface.c
@@ -786,7 +786,7 @@ cairo_os2_surface_create (HPS hps_client_window,
 
  error_exit:
 
-    /* This point will only be reached if an error occured */
+    /* This point will only be reached if an error occurred */
 
     if (local_os2_surface) {
         if (local_os2_surface->pixels)
diff --git a/src/cairo-region.c b/src/cairo-region.c
index a7ec50c..9e03272 100644
--- a/src/cairo-region.c
+++ b/src/cairo-region.c
@@ -516,7 +516,7 @@ slim_hidden_def (cairo_region_get_extents);
  * cairo_region_status:
  * @region: a #cairo_region_t
  *
- * Checks whether an error has previous occured for this
+ * Checks whether an error has previous occurred for this
  * region object.
  *
  * Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY
diff --git a/src/cairo-types-private.h b/src/cairo-types-private.h
index 3a1882b..7fcdd1d 100644
--- a/src/cairo-types-private.h
+++ b/src/cairo-types-private.h
@@ -131,7 +131,7 @@ struct _cairo_observer {
  *
  *	_cairo_hash_table_insert (hash_table, &my_entry->base);
  *
- * IMPORTANT: The caller is reponsible for initializing
+ * IMPORTANT: The caller is responsible for initializing
  * my_entry->base.hash with a hash code derived from the key. The
  * essential property of the hash code is that keys_equal must never
  * return %TRUE for two keys that have different hashes. The best hash
diff --git a/src/cairo-wideint-private.h b/src/cairo-wideint-private.h
index 24c506a..4051a1d 100644
--- a/src/cairo-wideint-private.h
+++ b/src/cairo-wideint-private.h
@@ -161,7 +161,7 @@ static cairo_always_inline double I _cairo_int64_to_double (cairo_int64_t i) { r
 #endif
 
 /*
- * 64-bit comparisions derived from lt or eq
+ * 64-bit comparisons derived from lt or eq
  */
 #define			_cairo_uint64_le(a,b)	    (!_cairo_uint64_gt(a,b))
 #define			_cairo_uint64_ne(a,b)	    (!_cairo_uint64_eq(a,b))
diff --git a/src/cairo-xcb-shm.c b/src/cairo-xcb-shm.c
index 6972720..5244036 100644
--- a/src/cairo-xcb-shm.c
+++ b/src/cairo-xcb-shm.c
@@ -473,7 +473,7 @@ _cairo_xcb_shm_process_pending (cairo_xcb_connection_t *connection, shm_wait_typ
 				      info->sync.sequence,
 				      (void **) &reply, NULL))
 		/* We cannot be sure the server finished with this image yet, so
-		 * try again later. All other shm info are guranteed to have a
+		 * try again later. All other shm info are guaranteed to have a
 		 * larger sequence number and thus don't have to be checked. */
 		return;
 	    break;
diff --git a/src/cairo.c b/src/cairo.c
index cbc3974..002d199 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -63,7 +63,7 @@
  * draw shapes with cairo_stroke() or cairo_fill().
  *
  * #cairo_t<!-- -->'s can be pushed to a stack via cairo_save().
- * They may then safely be changed, without loosing the current state.
+ * They may then safely be changed, without losing the current state.
  * Use cairo_restore() to restore to the saved state.
  */
 
diff --git a/src/drm/cairo-drm-intel-brw-eu-emit.c b/src/drm/cairo-drm-intel-brw-eu-emit.c
index 05bac0a..f27b238 100644
--- a/src/drm/cairo-drm-intel-brw-eu-emit.c
+++ b/src/drm/cairo-drm-intel-brw-eu-emit.c
@@ -476,7 +476,7 @@ struct brw_instruction *brw_JMPI(struct brw_compile *p,
  *
  * When the matching 'else' instruction is reached (presumably by
  * countdown of the instruction count patched in by our ELSE/ENDIF
- * functions), the relevent flags are inverted.
+ * functions), the relevant flags are inverted.
  *
  * When the matching 'endif' instruction is reached, the flags are
  * popped off.  If the stack is now empty, normal execution resumes.
diff --git a/src/win32/cairo-win32-font.c b/src/win32/cairo-win32-font.c
index ed171c2..014f604 100644
--- a/src/win32/cairo-win32-font.c
+++ b/src/win32/cairo-win32-font.c
@@ -1647,7 +1647,7 @@ _cairo_win32_scaled_font_is_synthetic (void	       *abstract_font)
 					&bold,
 					&italic);
     /* If this doesn't work assume it is not synthetic to avoid
-     * unneccessary subsetting fallbacks. */
+     * unnecessary subsetting fallbacks. */
     if (status != CAIRO_STATUS_SUCCESS)
 	return FALSE;
 
diff --git a/test/Makefile.am b/test/Makefile.am
index 0a36780..b5bdabf 100644
--- a/test/Makefile.am
+++ b/test/Makefile.am
@@ -164,7 +164,7 @@ reference
 #                         convert degenerate segments into circles/rectangles
 #                         as expected by cairo
 # device-offset-scale   - complication of pre-multiplying device_offset
-#                         into the pattern_matrix and then requiring futher
+#                         into the pattern_matrix and then requiring further
 #                         manipulation for SVG
 # extend-pad            - lacks implementation in pixman and consequently used
 #                         as an excuse for lack of support in other backends
diff --git a/test/README b/test/README
index 28f4747..b8effea 100644
--- a/test/README
+++ b/test/README
@@ -57,7 +57,7 @@ this is interfering with the results, you can clear the cached results using:
 
   make clean-caches
 
-Running tests under modified enviroments or tools
+Running tests under modified environments or tools
 -------------------------------------------------
 To run tests under a tool like gdb, one can use the run target and
 the TOOL variable.  For example:
diff --git a/test/dash-offset.c b/test/dash-offset.c
index 0e53687..f4269ee 100644
--- a/test/dash-offset.c
+++ b/test/dash-offset.c
@@ -37,7 +37,7 @@ static const double frac_offset[] = { 0, 2, 4, 6 };
  * This corresponds to the non-inverted part only if
  * the dash pattern has odd length, so the expected result
  * is the same for every int_offset if the pattern has
- * even lenght, and inverted each time (or shifted by half
+ * even length, and inverted each time (or shifted by half
  * period, which is the same) if the pattern has odd length. */
 static const double int_offset[] = { -2, -1, 0, 1, 2 };
 
diff --git a/test/glyph-cache-pressure.c b/test/glyph-cache-pressure.c
index 770b39f..eb4f7c5 100644
--- a/test/glyph-cache-pressure.c
+++ b/test/glyph-cache-pressure.c
@@ -38,7 +38,7 @@
  *	https://bugs.freedesktop.org/show_bug.cgi?id=6955
  *
  *   We replicate this bug by using the cairo_scaled_font_set_max_glyphs_per_font
- *   function to artifically induce cache pressure. (This function was added
+ *   function to artificially induce cache pressure. (This function was added
  *   for this very purpose.)
  *
  * 2006-06-22  Carl Worth  <[email protected]>
diff --git a/util/cairo-trace/cairo-trace.in b/util/cairo-trace/cairo-trace.in
index 1fc3de6..ece90d3 100644
--- a/util/cairo-trace/cairo-trace.in
+++ b/util/cairo-trace/cairo-trace.in
@@ -25,7 +25,7 @@ Whatever else happens is driven by its argument:
   --compress      - Compress the output with LZMA
   --profile       - Combine --no-callers and --no-mark-dirty and --compress
 
-Enviroment variables understood by cairo-trace:
+Environment variables understood by cairo-trace:
   CAIRO_TRACE_FLUSH - flush the output after every function call.
   CAIRO_TRACE_LINE_INFO - emit line information for most function calls.
 EOF
-- 
1.7.2.5

From bbed31cb62a9ea1370e244ba1d7717d11d87db9f Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 23:19:20 +0100
Subject: [PATCH 10/25] doc: preserve whitespace by using docbook screen tag

Using the programlisting tag is not appropriate everywhere. Use the
screen tag where the formatting shall be preserved and the text is no
code listing.

Also add whitespace to prevent gtk-doc from inserting paragraph breaks.
---
 src/cairo-pattern.c |    4 ++--
 src/cairo-version.c |   18 +++++++++---------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/cairo-pattern.c b/src/cairo-pattern.c
index eaf3c57..205dfe0 100644
--- a/src/cairo-pattern.c
+++ b/src/cairo-pattern.c
@@ -878,7 +878,7 @@ static const int mesh_control_point_j[4] = { 1, 2, 2, 1 };
  * Degenerate sides are permitted so straight lines may be used. A
  * zero length line on one side may be used to create 3 sided patches.
  *
- * <informalexample><programlisting>
+ * <informalexample><screen>
  *       C1     Side 1       C2
  *        +---------------+
  *        |               |
@@ -891,7 +891,7 @@ static const int mesh_control_point_j[4] = { 1, 2, 2, 1 };
  *        |               |
  *        +---------------+
  *      C0     Side 3        C3
- * </programlisting></informalexample>
+ * </screen></informalexample>
  *
  * Each patch is constructed by first calling
  * cairo_mesh_pattern_begin_patch(), then cairo_mesh_pattern_move_to()
diff --git a/src/cairo-version.c b/src/cairo-version.c
index 2f53e11..bc7fe10 100644
--- a/src/cairo-version.c
+++ b/src/cairo-version.c
@@ -54,31 +54,31 @@
  * vs. in-progress development, (such as from git instead of a tar file,
  * or as a "snapshot" tar file as opposed to a "release" tar file).
  *
- * <informalexample><programlisting>
+ * <informalexample><screen>
  *  _____ Major. Always 1, until we invent a new scheme.
  * /  ___ Minor. Even/Odd = Release/Snapshot (tar files) or Branch/Head (git)
  * | /  _ Micro. Even/Odd = Tar-file/git
  * | | /
  * 1.0.0
- * </programlisting></informalexample>
+ * </screen></informalexample>
  *
  * Here are a few examples of versions that one might see.
- * <informalexample><programlisting>
+ * <informalexample><screen>
  * Releases
  * --------
  * 1.0.0 - A major release
  * 1.0.2 - A subsequent maintenance release
  * 1.2.0 - Another major release
- *
+ * &nbsp;
  * Snapshots
  * ---------
  * 1.1.2 - A snapshot (working toward the 1.2.0 release)
- *
+ * &nbsp;
  * In-progress development (eg. from git)
  * --------------------------------------
  * 1.0.1 - Development on a maintenance branch (toward 1.0.2 release)
  * 1.1.1 - Development on head (toward 1.1.2 snapshot and 1.2.0 release)
- * </programlisting></informalexample>
+ * </screen></informalexample>
  * </para>
  * <refsect2>
  * <title>Compatibility</title>
@@ -112,17 +112,17 @@
  * an encoded form suitable for direct comparison. Cairo also provides the
  * macro CAIRO_VERSION_ENCODE() to perform the encoding.
  *
- * <informalexample><programlisting>
+ * <informalexample><screen>
  * Compile-time
  * ------------
  * CAIRO_VERSION_STRING    Human-readable
  * CAIRO_VERSION           Encoded, suitable for comparison
- *
+ * &nbsp;
  * Run-time
  * --------
  * cairo_version_string()  Human-readable
  * cairo_version()         Encoded, suitable for comparison
- * </programlisting></informalexample>
+ * </screen></informalexample>
  *
  * For example, checking that the cairo version is greater than or equal
  * to 1.0.0 could be achieved at compile-time or run-time as follows:
-- 
1.7.2.5

From f5230eef2caf53a60ea4d4b36788668f1515009c Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 23:31:25 +0100
Subject: [PATCH 11/25] doc: symbol names in header and comment must match

The names of the function arguments in the function prototype and
in the description comment must match, otherwise gtk-doc is confused.
When the argument names differ between function prototype and
definition, use the names from the prototype.

Also add a missing colon.
---
 src/cairo-ft.h                   |    4 ++--
 src/cairo-quartz-image-surface.c |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/cairo-ft.h b/src/cairo-ft.h
index 1006727..44344b7 100644
--- a/src/cairo-ft.h
+++ b/src/cairo-ft.h
@@ -83,11 +83,11 @@ typedef enum {
 
 cairo_public void
 cairo_ft_font_face_set_synthesize (cairo_font_face_t *font_face,
-				   unsigned int flags);
+				   unsigned int synth_flags);
 
 cairo_public void
 cairo_ft_font_face_unset_synthesize (cairo_font_face_t *font_face,
-				     unsigned int flags);
+				     unsigned int synth_flags);
 
 cairo_public unsigned int
 cairo_ft_font_face_get_synthesize (cairo_font_face_t *font_face);
diff --git a/src/cairo-quartz-image-surface.c b/src/cairo-quartz-image-surface.c
index 19cd424..5adf521 100644
--- a/src/cairo-quartz-image-surface.c
+++ b/src/cairo-quartz-image-surface.c
@@ -283,8 +283,8 @@ static const cairo_surface_backend_t cairo_quartz_image_surface_backend = {
 };
 
 /**
- * cairo_quartz_image_surface_create
- * @surface: a cairo image surface to wrap with a quartz image surface
+ * cairo_quartz_image_surface_create:
+ * @image_surface: a cairo image surface to wrap with a quartz image surface
  *
  * Creates a Quartz surface backed by a CGImageRef that references the
  * given image surface. The resulting surface can be rendered quickly
-- 
1.7.2.5

From d6ae3b11173cb1660fa98cccf834ef8dfe2bb06d Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sat, 3 Mar 2012 23:43:56 +0100
Subject: [PATCH 12/25] doc: ensure "compatibility" spelling

This changes not only comments, but also code!
---
 src/cairo-cogl-gradient-private.h |    6 +++---
 src/cairo-cogl-gradient.c         |   22 +++++++++++-----------
 src/cairo-xlib-surface.c          |    2 +-
 3 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/src/cairo-cogl-gradient-private.h b/src/cairo-cogl-gradient-private.h
index 9589b07..fa684d2 100644
--- a/src/cairo-cogl-gradient-private.h
+++ b/src/cairo-cogl-gradient-private.h
@@ -39,19 +39,19 @@
 
 #define CAIRO_COGL_LINEAR_GRADIENT_CACHE_SIZE (1024 * 1024)
 
-typedef enum _cairo_cogl_gradient_compatability {
+typedef enum _cairo_cogl_gradient_compatibility {
     CAIRO_COGL_GRADIENT_CAN_EXTEND_PAD	    = 1<<0,
     CAIRO_COGL_GRADIENT_CAN_EXTEND_REPEAT   = 1<<1,
     CAIRO_COGL_GRADIENT_CAN_EXTEND_REFLECT  = 1<<2,
     CAIRO_COGL_GRADIENT_CAN_EXTEND_NONE	    = 1<<3
-} cairo_cogl_gradient_compatability_t;
+} cairo_cogl_gradient_compatibility_t;
 #define CAIRO_COGL_GRADIENT_CAN_EXTEND_ALL (CAIRO_COGL_GRADIENT_CAN_EXTEND_PAD |\
 					    CAIRO_COGL_GRADIENT_CAN_EXTEND_REPEAT|\
 					    CAIRO_COGL_GRADIENT_CAN_EXTEND_REFLECT|\
 					    CAIRO_COGL_GRADIENT_CAN_EXTEND_NONE)
 
 typedef struct _cairo_cogl_linear_texture_entry {
-    cairo_cogl_gradient_compatability_t compatability;
+    cairo_cogl_gradient_compatibility_t compatibility;
     CoglTexture	*texture;
     float translate_x;
     float scale_x;
diff --git a/src/cairo-cogl-gradient.c b/src/cairo-cogl-gradient.c
index a4b9824..f8c8004 100644
--- a/src/cairo-cogl-gradient.c
+++ b/src/cairo-cogl-gradient.c
@@ -217,8 +217,8 @@ _cairo_cogl_linear_gradient_format_for_stops (cairo_extend_t		   extend,
     return COGL_PIXEL_FORMAT_BGR_888;
 }
 
-static cairo_cogl_gradient_compatability_t
-_cairo_cogl_compatability_from_extend_mode (cairo_extend_t extend_mode)
+static cairo_cogl_gradient_compatibility_t
+_cairo_cogl_compatibility_from_extend_mode (cairo_extend_t extend_mode)
 {
     switch (extend_mode)
     {
@@ -241,11 +241,11 @@ _cairo_cogl_linear_gradient_texture_for_extend (cairo_cogl_linear_gradient_t *gr
 						cairo_extend_t extend_mode)
 {
     GList *l;
-    cairo_cogl_gradient_compatability_t compatability =
-	_cairo_cogl_compatability_from_extend_mode (extend_mode);
+    cairo_cogl_gradient_compatibility_t compatibility =
+	_cairo_cogl_compatibility_from_extend_mode (extend_mode);
     for (l = gradient->textures; l; l = l->next) {
 	cairo_cogl_linear_texture_entry_t *entry = l->data;
-	if (entry->compatability & compatability)
+	if (entry->compatibility & compatibility)
 	    return entry;
     }
     return NULL;
@@ -364,7 +364,7 @@ _cairo_cogl_get_linear_gradient (cairo_cogl_device_t *device,
     int stop_offset;
     int n_internal_stops;
     int n;
-    cairo_cogl_gradient_compatability_t compatabilities;
+    cairo_cogl_gradient_compatibility_t compatibilities;
     int width;
     int left_padding = 0;
     cairo_color_stop_t left_padding_color;
@@ -419,7 +419,7 @@ _cairo_cogl_get_linear_gradient (cairo_cogl_device_t *device,
 	goto BAIL;
     }
 
-    compatabilities = _cairo_cogl_compatability_from_extend_mode (extend_mode);
+    compatibilities = _cairo_cogl_compatibility_from_extend_mode (extend_mode);
 
     n_internal_stops = n_stops;
     stop_offset = 0;
@@ -431,7 +431,7 @@ _cairo_cogl_get_linear_gradient (cairo_cogl_device_t *device,
     {
 	/* If we don't need any extra stops then actually the texture
 	 * will be shareable for repeat and reflect... */
-	compatabilities = (CAIRO_COGL_GRADIENT_CAN_EXTEND_REPEAT |
+	compatibilities = (CAIRO_COGL_GRADIENT_CAN_EXTEND_REPEAT |
 			   CAIRO_COGL_GRADIENT_CAN_EXTEND_REFLECT);
 
 	if (stops[0].offset != 0) {
@@ -464,7 +464,7 @@ _cairo_cogl_get_linear_gradient (cairo_cogl_device_t *device,
     if (n_internal_stops != n_stops)
     {
 	if (extend_mode == CAIRO_EXTEND_REPEAT) {
-	    compatabilities &= ~CAIRO_COGL_GRADIENT_CAN_EXTEND_REFLECT;
+	    compatibilities &= ~CAIRO_COGL_GRADIENT_CAN_EXTEND_REFLECT;
 	    if (stops[0].offset != 0) {
 		/* what's the wrap-around distance between the user's end-stops? */
 		double dx = (1.0 - stops[n_stops - 1].offset) + stops[0].offset;
@@ -479,7 +479,7 @@ _cairo_cogl_get_linear_gradient (cairo_cogl_device_t *device,
 		internal_stops[n_internal_stops - 1].color = internal_stops[0].color;
 	    }
 	} else if (extend_mode == CAIRO_EXTEND_REFLECT) {
-	    compatabilities &= ~CAIRO_COGL_GRADIENT_CAN_EXTEND_REPEAT;
+	    compatibilities &= ~CAIRO_COGL_GRADIENT_CAN_EXTEND_REPEAT;
 	    if (stops[0].offset != 0) {
 		internal_stops[0].offset = 0;
 		internal_stops[0].color = stops[n_stops - 1].color;
@@ -571,7 +571,7 @@ _cairo_cogl_get_linear_gradient (cairo_cogl_device_t *device,
     }
 
     entry->texture = COGL_TEXTURE (tex);
-    entry->compatability = compatabilities;
+    entry->compatibility = compatibilities;
 
     un_padded_width = width - left_padding - right_padding;
 
diff --git a/src/cairo-xlib-surface.c b/src/cairo-xlib-surface.c
index 563e964..4664c96 100644
--- a/src/cairo-xlib-surface.c
+++ b/src/cairo-xlib-surface.c
@@ -318,7 +318,7 @@ _cairo_xlib_surface_create_similar (void	       *abstract_src,
 	Screen *screen = src->screen->screen;
 	int depth;
 
-	/* No compatabile XRenderFormat, see if we can make an ordinary pixmap,
+	/* No compatible XRenderFormat, see if we can make an ordinary pixmap,
 	 * so that we can still accelerate blits with XCopyArea(). */
 	if (content != CAIRO_CONTENT_COLOR) {
             cairo_device_release (&display->base);
-- 
1.7.2.5

From 9b637b0887fa8c516f06fe112ef4295fa9f482ba Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 12:05:04 +0100
Subject: [PATCH 13/25] doc: add description for cairo_quartz_image_surface_get_image

---
 src/cairo-quartz-image-surface.c |   13 ++++++++++++-
 1 files changed, 12 insertions(+), 1 deletions(-)

diff --git a/src/cairo-quartz-image-surface.c b/src/cairo-quartz-image-surface.c
index 5adf521..2c0d4a1 100644
--- a/src/cairo-quartz-image-surface.c
+++ b/src/cairo-quartz-image-surface.c
@@ -371,7 +371,18 @@ cairo_quartz_image_surface_create (cairo_surface_t *surface)
     return &qisurf->base;
 }
 
-
+/**
+ * cairo_quartz_image_surface_get_image:
+ * @surface: a quartz image surface
+ *
+ * Obtain the actual image surface that is referenced by the Quartz
+ * image surface.
+ *
+ * Return value: the cairo image surface wrapped in the Quartz image
+ * surface
+ *
+ * Since: 1.6
+ **/
 cairo_surface_t *
 cairo_quartz_image_surface_get_image (cairo_surface_t *asurface)
 {
-- 
1.7.2.5

From 145b04275e2b7d3dcad3228e1707a3d6569f0db3 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 12:37:21 +0100
Subject: [PATCH 14/25] doc: add Returns statements and one parameter description

---
 src/cairo-raster-source-pattern.c |    2 ++
 src/cairo.h                       |    5 +++++
 2 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/src/cairo-raster-source-pattern.c b/src/cairo-raster-source-pattern.c
index f096862..c0525e7 100644
--- a/src/cairo-raster-source-pattern.c
+++ b/src/cairo-raster-source-pattern.c
@@ -218,6 +218,8 @@ cairo_raster_source_pattern_set_callback_data (cairo_pattern_t *abstract_pattern
  *
  * Queries the current user data.
  *
+ * Returns: The user data of the pattern
+ *
  * Since: 1.12
  **/
 void *
diff --git a/src/cairo.h b/src/cairo.h
index d23cd10..4d02bad 100644
--- a/src/cairo.h
+++ b/src/cairo.h
@@ -2543,6 +2543,8 @@ typedef void
  * is expected to provide the pixel data that was current at the time
  * of snapshotting.
  *
+ * Returns: %CAIRO_STATUS_SUCCESS upon success, or an error status on error.
+ *
  * Since: 1.12
  **/
 typedef cairo_status_t
@@ -2553,10 +2555,13 @@ typedef cairo_status_t
  * cairo_raster_source_copy_func_t:
  * @pattern: the pattern being rendered from
  * @callback_data: the user data supplied during creation
+ * @other: the copy
  *
  * #cairo_raster_source_copy_func_t is the type of function which is
  * called when the pattern gets copied as a normal part of rendering.
  *
+ * Returns: %CAIRO_STATUS_SUCCESS upon success, or an error status on error.
+ *
  * Since: 1.12
  **/
 typedef cairo_status_t
-- 
1.7.2.5

From 163abb946fe5224a1f45922c35e190400f1d8684 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 12:45:04 +0100
Subject: [PATCH 15/25] doc: move value descriptions up

to make gtk-doc happy
---
 src/cairo-ft.h |    7 +++----
 1 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/src/cairo-ft.h b/src/cairo-ft.h
index 44344b7..29c43c9 100644
--- a/src/cairo-ft.h
+++ b/src/cairo-ft.h
@@ -58,6 +58,9 @@ cairo_ft_font_face_create_for_ft_face (FT_Face         face,
 
 /**
  * cairo_ft_synthesize_t:
+ * @CAIRO_FT_SYNTHESIZE_BOLD: Embolden the glyphs (redraw with a pixel offset)
+ * @CAIRO_FT_SYNTHESIZE_OBLIQUE: Slant the glyph outline by 12 degrees to the
+ * right.
  *
  * A set of synthesis options to control how FreeType renders the glyphs
  * for a particular font face.
@@ -70,10 +73,6 @@ cairo_ft_font_face_create_for_ft_face (FT_Face         face,
  * Note: that when synthesizing glyphs, the font metrics returned will only
  * be estimates.
  *
- * @CAIRO_FT_SYNTHESIZE_BOLD: Embolden the glyphs (redraw with a pixel offset)
- * @CAIRO_FT_SYNTHESIZE_OBLIQUE: Slant the glyph outline by 12 degrees to the
- * right.
- *
  * Since: 1.12
  **/
 typedef enum {
-- 
1.7.2.5

From fd192ce7ff8efa16bd554567e23f3d318cc47cbd Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 13:20:15 +0100
Subject: [PATCH 16/25] doc: avoid confusing gtk-doc by double asterisks

---
 src/drm/cairo-drm-i915-private.h        |   24 +++---
 src/drm/cairo-drm-i965-shader.c         |    4 +-
 src/drm/cairo-drm-intel-brw-eu.c        |   26 +++---
 src/drm/cairo-drm-intel-brw-eu.h        |   50 ++++++------
 src/drm/cairo-drm-intel-ioctl-private.h |  126 +++++++++++++++---------------
 5 files changed, 115 insertions(+), 115 deletions(-)

diff --git a/src/drm/cairo-drm-i915-private.h b/src/drm/cairo-drm-i915-private.h
index 1581cab..8b2e422 100644
--- a/src/drm/cairo-drm-i915-private.h
+++ b/src/drm/cairo-drm-i915-private.h
@@ -343,7 +343,7 @@ enum i915_fs_channel {
     (z##_CHANNEL_VAL << Z_CHANNEL_SHIFT) | \
     (w##_CHANNEL_VAL << W_CHANNEL_SHIFT)
 
-/**
+/*
  * Construct an operand description for using a register with no swizzling
  */
 #define i915_fs_operand_reg(reg)					\
@@ -352,17 +352,17 @@ enum i915_fs_channel {
 #define i915_fs_operand_reg_negate(reg)					\
     i915_fs_operand(reg, NEG_X, NEG_Y, NEG_Z, NEG_W)
 
-/**
+/*
  * Returns an operand containing (0.0, 0.0, 0.0, 0.0).
  */
 #define i915_fs_operand_zero() i915_fs_operand(FS_R0, ZERO, ZERO, ZERO, ZERO)
 
-/**
+/*
  * Returns an unused operand
  */
 #define i915_fs_operand_none() i915_fs_operand_zero()
 
-/**
+/*
  * Returns an operand containing (1.0, 1.0, 1.0, 1.0).
  */
 #define i915_fs_operand_one() i915_fs_operand(FS_R0, ONE, ONE, ONE, ONE)
@@ -370,7 +370,7 @@ enum i915_fs_channel {
 #define i915_get_hardware_channel_val(val, shift, negate) \
     (((val & 0x7) << shift) | ((val & 0x8) ? negate : 0))
 
-/**
+/*
  * Outputs a fragment shader command to declare a sampler or texture register.
  */
 #define i915_fs_dcl(reg)						\
@@ -527,19 +527,19 @@ do { \
 	           i915_fs_operand_none(),			\
 	           i915_fs_operand_none())
 
-/** Add operand0 and operand1 and put the result in dest_reg */
+/* Add operand0 and operand1 and put the result in dest_reg */
 #define i915_fs_add(dest_reg, operand0, operand1)			\
     i915_fs_arith (ADD, dest_reg, \
 	           operand0, operand1,	\
 		   i915_fs_operand_none())
 
-/** Multiply operand0 and operand1 and put the result in dest_reg */
+/* Multiply operand0 and operand1 and put the result in dest_reg */
 #define i915_fs_mul(dest_reg, operand0, operand1)			\
     i915_fs_arith (MUL, dest_reg, \
 	           operand0, operand1,	\
 		   i915_fs_operand_none())
 
-/** Computes 1/sqrt(operand0.replicate_swizzle) puts the result in dest_reg */
+/* Computes 1/sqrt(operand0.replicate_swizzle) puts the result in dest_reg */
 #define i915_fs_rsq(dest_reg, dest_mask, operand0)		\
 do {									\
     if (dest_mask) {							\
@@ -555,13 +555,13 @@ do {									\
     } \
 } while (0)
 
-/** Puts the minimum of operand0 and operand1 in dest_reg */
+/* Puts the minimum of operand0 and operand1 in dest_reg */
 #define i915_fs_min(dest_reg, operand0, operand1)			\
     i915_fs_arith (MIN, dest_reg, \
 	           operand0, operand1, \
 		   i915_fs_operand_none())
 
-/** Puts the maximum of operand0 and operand1 in dest_reg */
+/* Puts the maximum of operand0 and operand1 in dest_reg */
 #define i915_fs_max(dest_reg, operand0, operand1)			\
     i915_fs_arith (MAX, dest_reg, \
 	           operand0, operand1, \
@@ -570,7 +570,7 @@ do {									\
 #define i915_fs_cmp(dest_reg, operand0, operand1, operand2)		\
     i915_fs_arith (CMP, dest_reg, operand0, operand1, operand2)
 
-/** Perform operand0 * operand1 + operand2 and put the result in dest_reg */
+/* Perform operand0 * operand1 + operand2 and put the result in dest_reg */
 #define i915_fs_mad(dest_reg, dest_mask, op0, op1, op2)	\
 do {									\
     if (dest_mask) {							\
@@ -589,7 +589,7 @@ do {									\
     } \
 } while (0)
 
-/**
+/*
  * Perform a 3-component dot-product of operand0 and operand1 and put the
  * resulting scalar in the channels of dest_reg specified by the dest_mask.
  */
diff --git a/src/drm/cairo-drm-i965-shader.c b/src/drm/cairo-drm-i965-shader.c
index f88e5a4..5465f42 100644
--- a/src/drm/cairo-drm-i965-shader.c
+++ b/src/drm/cairo-drm-i965-shader.c
@@ -939,7 +939,7 @@ i965_shader_setup_constants (i965_shader_t *shader)
     assert (shader->constants_size < ARRAY_LENGTH (shader->constants));
 }
 
-/**
+/*
  * Highest-valued BLENDFACTOR used in i965_blend_op.
  *
  * This leaves out BRW_BLENDFACTOR_INV_DST_COLOR,
@@ -1630,7 +1630,7 @@ i965_sf_state_equal (const void *A, const void *B)
     return a->hash == b->hash;
 }
 
-/**
+/*
  * Sets up the SF state pointing at an SF kernel.
  *
  * The SF kernel does coord interp: for each attribute,
diff --git a/src/drm/cairo-drm-intel-brw-eu.c b/src/drm/cairo-drm-intel-brw-eu.c
index 51c3de4..2b47d8c 100644
--- a/src/drm/cairo-drm-intel-brw-eu.c
+++ b/src/drm/cairo-drm-intel-brw-eu.c
@@ -127,7 +127,7 @@ brw_get_program (struct brw_compile *p,
 
 
 
-/**
+/*
  * Subroutine calls require special attention.
  * Mesa instructions may be expanded into multiple hardware instructions
  * so the prog_instruction::BranchTarget field can't be used as an index
@@ -142,29 +142,29 @@ brw_get_program (struct brw_compile *p,
  */
 
 
-/**
+/*
  * For each OPCODE_BGNSUB we create one of these.
  */
 struct brw_glsl_label
 {
-    const char *name; /**< the label string */
-    uint32_t position;  /**< the position of the brw instruction for this label */
-    struct brw_glsl_label *next;  /**< next in linked list */
+    const char *name; /*< the label string */
+    uint32_t position;  /*< the position of the brw instruction for this label */
+    struct brw_glsl_label *next;  /*< next in linked list */
 };
 
 
-/**
+/*
  * For each OPCODE_CAL we create one of these.
  */
 struct brw_glsl_call
 {
-    uint32_t call_inst_pos;  /**< location of the CAL instruction */
-    const char *sub_name;  /**< name of subroutine to call */
-    struct brw_glsl_call *next;  /**< next in linked list */
+    uint32_t call_inst_pos;  /*< location of the CAL instruction */
+    const char *sub_name;  /*< name of subroutine to call */
+    struct brw_glsl_call *next;  /*< next in linked list */
 };
 
 
-/**
+/*
  * Called for each OPCODE_BGNSUB.
  */
     void
@@ -178,7 +178,7 @@ brw_save_label(struct brw_compile *c, const char *name, uint32_t position)
 }
 
 
-/**
+/*
  * Called for each OPCODE_CAL.
  */
     void
@@ -192,7 +192,7 @@ brw_save_call(struct brw_compile *c, const char *name, uint32_t call_pos)
 }
 
 
-/**
+/*
  * Lookup a label, return label's position/offset.
  */
     static uint32_t
@@ -209,7 +209,7 @@ brw_lookup_label(struct brw_compile *c, const char *name)
 }
 
 
-/**
+/*
  * When we're done generating code, this function is called to resolve
  * subroutine calls.
  */
diff --git a/src/drm/cairo-drm-intel-brw-eu.h b/src/drm/cairo-drm-intel-brw-eu.h
index 197a371..2662a2e 100644
--- a/src/drm/cairo-drm-intel-brw-eu.h
+++ b/src/drm/cairo-drm-intel-brw-eu.h
@@ -38,7 +38,7 @@
 #include <assert.h>
 
 
-/**
+/*
  * Writemask values, 1 bit per component.
  */
 #define WRITEMASK_X     0x1
@@ -127,8 +127,8 @@ struct brw_compile {
    int single_program_flow;
    struct brw_context *brw;
 
-   struct brw_glsl_label *first_label;  /**< linked list of labels */
-   struct brw_glsl_call *first_call;    /**< linked list of CALs */
+   struct brw_glsl_label *first_label;  /*< linked list of labels */
+   struct brw_glsl_call *first_call;    /*< linked list of CALs */
 };
 
 cairo_private void
@@ -164,7 +164,7 @@ type_sz (uint32_t type)
    }
 }
 
-/**
+/*
  * Construct a brw_reg.
  * \param file  one of the BRW_x_REGISTER_FILE values
  * \param nr  register number/index
@@ -222,7 +222,7 @@ brw_reg (uint32_t file,
    return reg;
 }
 
-/** Construct float[16] register */
+/* Construct float[16] register */
 static cairo_always_inline struct brw_reg
 brw_vec16_reg (uint32_t file,
 	       uint32_t nr,
@@ -237,7 +237,7 @@ brw_vec16_reg (uint32_t file,
 		    WRITEMASK_XYZW);
 }
 
-/** Construct float[8] register */
+/* Construct float[8] register */
 static cairo_always_inline struct brw_reg
 brw_vec8_reg (uint32_t file,
 	      uint32_t nr,
@@ -252,7 +252,7 @@ brw_vec8_reg (uint32_t file,
 		    WRITEMASK_XYZW);
 }
 
-/** Construct float[4] register */
+/* Construct float[4] register */
 static cairo_always_inline struct brw_reg
 brw_vec4_reg (uint32_t file,
 	      uint32_t nr,
@@ -267,7 +267,7 @@ brw_vec4_reg (uint32_t file,
 		   WRITEMASK_XYZW);
 }
 
-/** Construct float[2] register */
+/* Construct float[2] register */
 static cairo_always_inline struct brw_reg
 brw_vec2_reg (uint32_t file,
 	      uint32_t nr,
@@ -282,7 +282,7 @@ brw_vec2_reg (uint32_t file,
 		   WRITEMASK_XY);
 }
 
-/** Construct float[1] register */
+/* Construct float[1] register */
 static cairo_always_inline struct brw_reg
 brw_vec1_reg (uint32_t file,
 	      uint32_t nr,
@@ -331,7 +331,7 @@ byte_offset (struct brw_reg reg,
    return reg;
 }
 
-/** Construct unsigned word[16] register */
+/* Construct unsigned word[16] register */
 static cairo_always_inline struct brw_reg
 brw_uw16_reg (uint32_t file,
 	      uint32_t nr,
@@ -340,7 +340,7 @@ brw_uw16_reg (uint32_t file,
    return suboffset (retype (brw_vec16_reg (file, nr, 0), BRW_REGISTER_TYPE_UW), subnr);
 }
 
-/** Construct unsigned word[8] register */
+/* Construct unsigned word[8] register */
 static cairo_always_inline struct brw_reg
 brw_uw8_reg (uint32_t file,
 	     uint32_t nr,
@@ -349,7 +349,7 @@ brw_uw8_reg (uint32_t file,
    return suboffset (retype (brw_vec8_reg (file, nr, 0), BRW_REGISTER_TYPE_UW), subnr);
 }
 
-/** Construct unsigned word[2] register */
+/* Construct unsigned word[2] register */
 static cairo_always_inline struct brw_reg
 brw_uw2_reg (uint32_t file,
 	     uint32_t nr,
@@ -358,7 +358,7 @@ brw_uw2_reg (uint32_t file,
    return suboffset (retype (brw_vec2_reg (file, nr, 0), BRW_REGISTER_TYPE_UW), subnr);
 }
 
-/** Construct unsigned word[1] register */
+/* Construct unsigned word[1] register */
 static cairo_always_inline struct brw_reg
 brw_uw1_reg (uint32_t file,
 	     uint32_t nr,
@@ -381,7 +381,7 @@ brw_imm_reg (uint32_t type)
 		   0);
 }
 
-/** Construct float immediate register */
+/* Construct float immediate register */
 static cairo_always_inline struct brw_reg brw_imm_f( float f )
 {
    struct brw_reg imm = brw_imm_reg(BRW_REGISTER_TYPE_F);
@@ -389,7 +389,7 @@ static cairo_always_inline struct brw_reg brw_imm_f( float f )
    return imm;
 }
 
-/** Construct integer immediate register */
+/* Construct integer immediate register */
 static cairo_always_inline struct brw_reg brw_imm_d( int32_t d )
 {
    struct brw_reg imm = brw_imm_reg(BRW_REGISTER_TYPE_D);
@@ -397,7 +397,7 @@ static cairo_always_inline struct brw_reg brw_imm_d( int32_t d )
    return imm;
 }
 
-/** Construct uint immediate register */
+/* Construct uint immediate register */
 static cairo_always_inline struct brw_reg brw_imm_ud( uint32_t ud )
 {
    struct brw_reg imm = brw_imm_reg(BRW_REGISTER_TYPE_UD);
@@ -405,7 +405,7 @@ static cairo_always_inline struct brw_reg brw_imm_ud( uint32_t ud )
    return imm;
 }
 
-/** Construct ushort immediate register */
+/* Construct ushort immediate register */
 static cairo_always_inline struct brw_reg brw_imm_uw( uint16_t uw )
 {
    struct brw_reg imm = brw_imm_reg(BRW_REGISTER_TYPE_UW);
@@ -413,7 +413,7 @@ static cairo_always_inline struct brw_reg brw_imm_uw( uint16_t uw )
    return imm;
 }
 
-/** Construct short immediate register */
+/* Construct short immediate register */
 static cairo_always_inline struct brw_reg brw_imm_w( int16_t w )
 {
    struct brw_reg imm = brw_imm_reg(BRW_REGISTER_TYPE_W);
@@ -425,7 +425,7 @@ static cairo_always_inline struct brw_reg brw_imm_w( int16_t w )
  * numbers alias with _V and _VF below:
  */
 
-/** Construct vector of eight signed half-byte values */
+/* Construct vector of eight signed half-byte values */
 static cairo_always_inline
 struct brw_reg brw_imm_v (uint32_t v)
 {
@@ -437,7 +437,7 @@ struct brw_reg brw_imm_v (uint32_t v)
    return imm;
 }
 
-/** Construct vector of four 8-bit float values */
+/* Construct vector of four 8-bit float values */
 static cairo_always_inline struct brw_reg
 brw_imm_vf (uint32_t v)
 {
@@ -476,28 +476,28 @@ brw_address (struct brw_reg reg)
    return brw_imm_uw (reg.nr * REG_SIZE + reg.subnr);
 }
 
-/** Construct float[1] general-purpose register */
+/* Construct float[1] general-purpose register */
 static cairo_always_inline struct brw_reg
 brw_vec1_grf (uint32_t nr, uint32_t subnr)
 {
    return brw_vec1_reg (BRW_GENERAL_REGISTER_FILE, nr, subnr);
 }
 
-/** Construct float[2] general-purpose register */
+/* Construct float[2] general-purpose register */
 static cairo_always_inline struct brw_reg
 brw_vec2_grf (uint32_t nr, uint32_t subnr)
 {
    return brw_vec2_reg (BRW_GENERAL_REGISTER_FILE, nr, subnr);
 }
 
-/** Construct float[4] general-purpose register */
+/* Construct float[4] general-purpose register */
 static cairo_always_inline struct brw_reg
 brw_vec4_grf (uint32_t nr, uint32_t subnr)
 {
    return brw_vec4_reg (BRW_GENERAL_REGISTER_FILE, nr, subnr);
 }
 
-/** Construct float[8] general-purpose register */
+/* Construct float[8] general-purpose register */
 static cairo_always_inline struct brw_reg
 brw_vec8_grf (uint32_t nr)
 {
@@ -516,7 +516,7 @@ brw_uw16_grf (uint32_t nr, uint32_t subnr)
    return brw_uw16_reg (BRW_GENERAL_REGISTER_FILE, nr, subnr);
 }
 
-/** Construct null register (usually used for setting condition codes) */
+/* Construct null register (usually used for setting condition codes) */
 static cairo_always_inline struct brw_reg
 brw_null_reg (void)
 {
diff --git a/src/drm/cairo-drm-intel-ioctl-private.h b/src/drm/cairo-drm-intel-ioctl-private.h
index 29fe88a..004d3bf 100644
--- a/src/drm/cairo-drm-intel-ioctl-private.h
+++ b/src/drm/cairo-drm-intel-ioctl-private.h
@@ -48,28 +48,28 @@ struct intel_getparam {
 };
 
 
-/** @{
+/* @{
  * Intel memory domains
  *
  * Most of these just align with the various caches in
  * the system and are used to flush and invalidate as
  * objects end up cached in different domains.
  */
-/** CPU cache */
+/* CPU cache */
 #define I915_GEM_DOMAIN_CPU		0x00000001
-/** Render cache, used by 2D and 3D drawing */
+/* Render cache, used by 2D and 3D drawing */
 #define I915_GEM_DOMAIN_RENDER		0x00000002
-/** Sampler cache, used by texture engine */
+/* Sampler cache, used by texture engine */
 #define I915_GEM_DOMAIN_SAMPLER		0x00000004
-/** Command queue, used to load batch buffers */
+/* Command queue, used to load batch buffers */
 #define I915_GEM_DOMAIN_COMMAND		0x00000008
-/** Instruction cache, used by shader programs */
+/* Instruction cache, used by shader programs */
 #define I915_GEM_DOMAIN_INSTRUCTION	0x00000010
-/** Vertex address cache */
+/* Vertex address cache */
 #define I915_GEM_DOMAIN_VERTEX		0x00000020
-/** GTT domain - aperture and scanout */
+/* GTT domain - aperture and scanout */
 #define I915_GEM_DOMAIN_GTT		0x00000040
-/** @} */
+/* @} */
 
 #define I915_TILING_NONE	0
 #define I915_TILING_X		1
@@ -95,13 +95,13 @@ struct intel_getparam {
 #define DRM_I915_GEM_MMAP_GTT	0x24
 
 struct drm_i915_gem_create {
-	/**
+	/*
 	 * Requested size for the object.
 	 *
 	 * The (page-aligned) allocated size for the object will be returned.
 	 */
 	uint64_t size;
-	/**
+	/*
 	 * Returned handle for the object.
 	 *
 	 * Object handles are nonzero.
@@ -111,14 +111,14 @@ struct drm_i915_gem_create {
 };
 
 struct drm_i915_gem_pread {
-	/** Handle for the object being read. */
+	/* Handle for the object being read. */
 	uint32_t handle;
 	uint32_t pad;
-	/** Offset into the object to read from */
+	/* Offset into the object to read from */
 	uint64_t offset;
-	/** Length of data to read */
+	/* Length of data to read */
 	uint64_t size;
-	/**
+	/*
 	 * Pointer to write the data into.
 	 *
 	 * This is a fixed-size type for 32/64 compatibility.
@@ -127,14 +127,14 @@ struct drm_i915_gem_pread {
 };
 
 struct drm_i915_gem_pwrite {
-	/** Handle for the object being written to. */
+	/* Handle for the object being written to. */
 	uint32_t handle;
 	uint32_t pad;
-	/** Offset into the object to write to */
+	/* Offset into the object to write to */
 	uint64_t offset;
-	/** Length of data to write */
+	/* Length of data to write */
 	uint64_t size;
-	/**
+	/*
 	 * Pointer to read the data from.
 	 *
 	 * This is a fixed-size type for 32/64 compatibility.
@@ -143,18 +143,18 @@ struct drm_i915_gem_pwrite {
 };
 
 struct drm_i915_gem_mmap {
-	/** Handle for the object being mapped. */
+	/* Handle for the object being mapped. */
 	uint32_t handle;
 	uint32_t pad;
-	/** Offset in the object to map. */
+	/* Offset in the object to map. */
 	uint64_t offset;
-	/**
+	/*
 	 * Length of data to map.
 	 *
 	 * The value will be page-aligned.
 	 */
 	uint64_t size;
-	/**
+	/*
 	 * Returned pointer the data was mapped at.
 	 *
 	 * This is a fixed-size type for 32/64 compatibility.
@@ -163,10 +163,10 @@ struct drm_i915_gem_mmap {
 };
 
 struct drm_i915_gem_mmap_gtt {
-	/** Handle for the object being mapped. */
+	/* Handle for the object being mapped. */
 	uint32_t handle;
 	uint32_t pad;
-	/**
+	/*
 	 * Fake offset to use for subsequent mmap call
 	 *
 	 * This is a fixed-size type for 32/64 compatibility.
@@ -175,18 +175,18 @@ struct drm_i915_gem_mmap_gtt {
 };
 
 struct drm_i915_gem_set_domain {
-	/** Handle for the object */
+	/* Handle for the object */
 	uint32_t handle;
 
-	/** New read domains */
+	/* New read domains */
 	uint32_t read_domains;
 
-	/** New write domain */
+	/* New write domain */
 	uint32_t write_domain;
 };
 
 struct drm_i915_gem_relocation_entry {
-	/**
+	/*
 	 * Handle of the buffer being pointed to by this relocation entry.
 	 *
 	 * It's appealing to make this be an index into the mm_validate_entry
@@ -196,16 +196,16 @@ struct drm_i915_gem_relocation_entry {
 	 */
 	uint32_t target_handle;
 
-	/**
+	/*
 	 * Value to be added to the offset of the target buffer to make up
 	 * the relocation entry.
 	 */
 	uint32_t delta;
 
-	/** Offset in the buffer the relocation entry will be written into */
+	/* Offset in the buffer the relocation entry will be written into */
 	uint64_t offset;
 
-	/**
+	/*
 	 * Offset value of the target buffer that the relocation entry was last
 	 * written as.
 	 *
@@ -215,12 +215,12 @@ struct drm_i915_gem_relocation_entry {
 	 */
 	uint64_t presumed_offset;
 
-	/**
+	/*
 	 * Target memory domains read by this operation.
 	 */
 	uint32_t read_domains;
 
-	/**
+	/*
 	 * Target memory domains written by this operation.
 	 *
 	 * Note that only one domain may be written by the whole
@@ -231,24 +231,24 @@ struct drm_i915_gem_relocation_entry {
 };
 
 struct drm_i915_gem_exec_object {
-	/**
+	/*
 	 * User's handle for a buffer to be bound into the GTT for this
 	 * operation.
 	 */
 	uint32_t handle;
 
-	/** Number of relocations to be performed on this buffer */
+	/* Number of relocations to be performed on this buffer */
 	uint32_t relocation_count;
-	/**
+	/*
 	 * Pointer to array of struct drm_i915_gem_relocation_entry containing
 	 * the relocations to be performed in this buffer.
 	 */
 	uint64_t relocs_ptr;
 
-	/** Required alignment in graphics aperture */
+	/* Required alignment in graphics aperture */
 	uint64_t alignment;
 
-	/**
+	/*
 	 * Returned value of the updated offset of the object, for future
 	 * presumed_offset writes.
 	 */
@@ -256,7 +256,7 @@ struct drm_i915_gem_exec_object {
 };
 
 struct drm_i915_gem_execbuffer {
-	/**
+	/*
 	 * List of buffers to be validated with their relocations to be
 	 * performend on them.
 	 *
@@ -269,30 +269,30 @@ struct drm_i915_gem_execbuffer {
 	uint64_t buffers_ptr;
 	uint32_t buffer_count;
 
-	/** Offset in the batchbuffer to start execution from. */
+	/* Offset in the batchbuffer to start execution from. */
 	uint32_t batch_start_offset;
-	/** Bytes used in batchbuffer from batch_start_offset */
+	/* Bytes used in batchbuffer from batch_start_offset */
 	uint32_t batch_len;
 	uint32_t DR1;
 	uint32_t DR4;
 	uint32_t num_cliprects;
-	/** This is a struct drm_clip_rect *cliprects */
+	/* This is a struct drm_clip_rect *cliprects */
 	uint64_t cliprects_ptr;
 };
 
 struct drm_i915_gem_busy {
-	/** Handle of the buffer to check for busy */
+	/* Handle of the buffer to check for busy */
 	uint32_t handle;
 
-	/** Return busy status (1 if busy, 0 if idle) */
+	/* Return busy status (1 if busy, 0 if idle) */
 	uint32_t busy;
 };
 
 struct drm_i915_gem_set_tiling {
-	/** Handle of the buffer to have its tiling state updated */
+	/* Handle of the buffer to have its tiling state updated */
 	uint32_t handle;
 
-	/**
+	/*
 	 * Tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
 	 * I915_TILING_Y).
 	 *
@@ -306,13 +306,13 @@ struct drm_i915_gem_set_tiling {
 	 */
 	uint32_t tiling_mode;
 
-	/**
+	/*
 	 * Stride in bytes for the object when in I915_TILING_X or
 	 * I915_TILING_Y.
 	 */
 	uint32_t stride;
 
-	/**
+	/*
 	 * Returned address bit 6 swizzling required for CPU access through
 	 * mmap mapping.
 	 */
@@ -320,16 +320,16 @@ struct drm_i915_gem_set_tiling {
 };
 
 struct drm_i915_gem_get_tiling {
-	/** Handle of the buffer to get tiling state for. */
+	/* Handle of the buffer to get tiling state for. */
 	uint32_t handle;
 
-	/**
+	/*
 	 * Current tiling mode for the object (I915_TILING_NONE, I915_TILING_X,
 	 * I915_TILING_Y).
 	 */
 	uint32_t tiling_mode;
 
-	/**
+	/*
 	 * Returned address bit 6 swizzling required for CPU access through
 	 * mmap mapping.
 	 */
@@ -337,10 +337,10 @@ struct drm_i915_gem_get_tiling {
 };
 
 struct drm_i915_gem_get_aperture {
-	/** Total size of the aperture used by i915_gem_execbuffer, in bytes */
+	/* Total size of the aperture used by i915_gem_execbuffer, in bytes */
 	uint64_t aper_size;
 
-	/**
+	/*
 	 * Available space in the aperture used by i915_gem_execbuffer, in
 	 * bytes
 	 */
@@ -377,24 +377,24 @@ struct drm_i915_gem_madvise {
 
 /* XXX execbuffer2 */
 struct drm_i915_gem_exec_object2 {
-	/**
+	/*
 	 * User's handle for a buffer to be bound into the GTT for this
 	 * operation.
 	 */
 	uint32_t handle;
 
-	/** Number of relocations to be performed on this buffer */
+	/* Number of relocations to be performed on this buffer */
 	uint32_t relocation_count;
-	/**
+	/*
 	 * Pointer to array of struct drm_i915_gem_relocation_entry containing
 	 * the relocations to be performed in this buffer.
 	 */
 	uint64_t relocs_ptr;
 
-	/** Required alignment in graphics aperture */
+	/* Required alignment in graphics aperture */
 	uint64_t alignment;
 
-	/**
+	/*
 	 * Returned value of the updated offset of the object, for future
 	 * presumed_offset writes.
 	 */
@@ -407,20 +407,20 @@ struct drm_i915_gem_exec_object2 {
 };
 
 struct drm_i915_gem_execbuffer2 {
-	/**
+	/*
 	 * List of gem_exec_object2 structs
 	 */
 	uint64_t buffers_ptr;
 	uint32_t buffer_count;
 
-	/** Offset in the batchbuffer to start execution from. */
+	/* Offset in the batchbuffer to start execution from. */
 	uint32_t batch_start_offset;
-	/** Bytes used in batchbuffer from batch_start_offset */
+	/* Bytes used in batchbuffer from batch_start_offset */
 	uint32_t batch_len;
 	uint32_t DR1;
 	uint32_t DR4;
 	uint32_t num_cliprects;
-	/** This is a struct drm_clip_rect *cliprects */
+	/* This is a struct drm_clip_rect *cliprects */
 	uint64_t cliprects_ptr;
 	uint64_t flags;
 	uint64_t rsvd1;
-- 
1.7.2.5

From 5444ef5e00d93ca66aaf040e959973b444fc0cff Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 13:49:17 +0100
Subject: [PATCH 17/25] doc: describe cairo_recording_surface_get_extents

---
 src/cairo-recording-surface.c |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)

diff --git a/src/cairo-recording-surface.c b/src/cairo-recording-surface.c
index 3eaf25d..ebe6f50 100644
--- a/src/cairo-recording-surface.c
+++ b/src/cairo-recording-surface.c
@@ -1724,6 +1724,18 @@ _cairo_recording_surface_get_ink_bbox (cairo_recording_surface_t *surface,
     return _recording_surface_get_ink_bbox (surface, bbox, transform);
 }
 
+/**
+ * cairo_recording_surface_get_extents:
+ * @surface: a #cairo_recording_surface_t
+ * @extents: the #cairo_rectangle_t to be assigned the extents
+ *
+ * Get the extents of the recording-surface.
+ *
+ * Return value: %TRUE if the surface is bounded, of recording type, and
+ * not in an error state, otherwise %FALSE
+ *
+ * Since: 1.12
+ **/
 cairo_bool_t
 cairo_recording_surface_get_extents (cairo_surface_t *surface,
 				     cairo_rectangle_t *extents)
-- 
1.7.2.5

From a9848a78460f64427453104785d56d9378d850f3 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 15:36:34 +0100
Subject: [PATCH 18/25] doc/ft-font: add reference to cairo_ft_synthesize_t

---
 src/cairo-ft-font.c |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c
index 32a5870..70e4a9e 100644
--- a/src/cairo-ft-font.c
+++ b/src/cairo-ft-font.c
@@ -3265,7 +3265,7 @@ cairo_ft_font_face_create_for_ft_face (FT_Face         face,
  *
  * FreeType provides the ability to synthesize different glyphs from a base
  * font, which is useful if you lack those glyphs from a true bold or oblique
- * font.
+ * font. See also #cairo_ft_synthesize_t.
  *
  * Since: 1.12
  **/
@@ -3308,6 +3308,8 @@ cairo_ft_font_face_unset_synthesize (cairo_font_face_t *font_face,
  * cairo_ft_font_face_get_synthesize:
  * @font_face: The #cairo_ft_font_face_t object to query
  *
+ * See #cairo_ft_synthesize_t.
+ *
  * Returns: the current set of synthesis options.
  *
  * Since: 1.12
-- 
1.7.2.5

From 360d8fe2d8e80a5c4d7a05ce97b6235b59c31a4a Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 17:52:58 +0100
Subject: [PATCH 19/25] doc/ps-surface: minor improvements

---
 src/cairo-ps-surface.c |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/src/cairo-ps-surface.c b/src/cairo-ps-surface.c
index e22e2cc..88c4834 100644
--- a/src/cairo-ps-surface.c
+++ b/src/cairo-ps-surface.c
@@ -1665,8 +1665,8 @@ color_is_gray (double red, double green, double blue)
  * @surface: returns surface of type image surface or recording surface
  * @image_extra: returns image extra for image type surface
  *
- * Acquire source surface surface or raster source pattern.
- */
+ * Acquire source surface or raster source pattern.
+ **/
 static cairo_status_t
 _cairo_ps_surface_acquire_source_surface_from_pattern (cairo_ps_surface_t           *surface,
 						       const cairo_pattern_t        *pattern,
@@ -1791,7 +1791,9 @@ _cairo_ps_surface_release_source_surface_from_pattern (cairo_ps_surface_t
  * @x_offset: returns x offset of padded image
  * @y_offset: returns y offset of padded image
  * @image: returns the padded image or NULL if padding not required to fill @extents
- */
+ *
+ * Creates a padded image if the source image does not fill the extents.
+ **/
 static cairo_status_t
 _cairo_ps_surface_create_padded_image_from_image (cairo_ps_surface_t           *surface,
 						  cairo_image_surface_t        *source,
-- 
1.7.2.5

From 937607772d938a495ceeb801f96a2bcb875b52b7 Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 16:52:22 +0100
Subject: [PATCH 20/25] doc/xlib/xcb: document get/set_precision API

---
 src/cairo-xcb-connection.c |   21 ++++++++++++++++++++-
 src/cairo-xlib-display.c   |   20 ++++++++++++++++++++
 2 files changed, 40 insertions(+), 1 deletions(-)

diff --git a/src/cairo-xcb-connection.c b/src/cairo-xcb-connection.c
index 661cdb3..95d6b8f 100644
--- a/src/cairo-xcb-connection.c
+++ b/src/cairo-xcb-connection.c
@@ -903,7 +903,16 @@ cairo_xcb_device_debug_cap_xrender_version (cairo_device_t *device,
 slim_hidden_def (cairo_xcb_device_debug_cap_xrender_version);
 #endif
 
-
+/**
+ * cairo_xcb_device_debug_set_precision:
+ * @device: a #cairo_device_t for the XCB backend
+ * @precision: the precision to use
+ *
+ * Render supports two modes of precision when rendering trapezoids. Set
+ * the precision to the desired mode.
+ *
+ * Since: 1.12
+ **/
 void
 cairo_xcb_device_debug_set_precision (cairo_device_t *device,
 				      int precision)
@@ -924,6 +933,16 @@ cairo_xcb_device_debug_set_precision (cairo_device_t *device,
 slim_hidden_def (cairo_xcb_device_debug_set_precision);
 #endif
 
+/**
+ * cairo_xcb_device_debug_get_precision:
+ * @device: a #cairo_device_t for the XCB backend
+ *
+ * Get the Xrender precision mode.
+ *
+ * Returns: the render precision mode
+ *
+ * Since: 1.12
+ **/
 int
 cairo_xcb_device_debug_get_precision (cairo_device_t *device)
 {
diff --git a/src/cairo-xlib-display.c b/src/cairo-xlib-display.c
index fd1575e..e2fa8f5 100644
--- a/src/cairo-xlib-display.c
+++ b/src/cairo-xlib-display.c
@@ -595,6 +595,16 @@ cairo_xlib_device_debug_cap_xrender_version (cairo_device_t *device,
     _cairo_xlib_display_select_compositor (display);
 }
 
+/**
+ * cairo_xlib_device_debug_set_precision:
+ * @device: a #cairo_device_t for the Xlib backend
+ * @precision: the precision to use
+ *
+ * Render supports two modes of precision when rendering trapezoids. Set
+ * the precision to the desired mode.
+ *
+ * Since: 1.12
+ **/
 void
 cairo_xlib_device_debug_set_precision (cairo_device_t *device,
 				       int precision)
@@ -612,6 +622,16 @@ cairo_xlib_device_debug_set_precision (cairo_device_t *device,
     ((cairo_xlib_display_t *) device)->force_precision = precision;
 }
 
+/**
+ * cairo_xlib_device_debug_get_precision:
+ * @device: a #cairo_device_t for the Xlib backend
+ *
+ * Get the Xrender precision mode.
+ *
+ * Returns: the render precision mode
+ *
+ * Since: 1.12
+ **/
 int
 cairo_xlib_device_debug_get_precision (cairo_device_t *device)
 {
-- 
1.7.2.5

From 3973a77eebfcb9446b47c92bf59724a5849714ac Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 17:04:15 +0100
Subject: [PATCH 21/25] doc/xcb: document cairo_xcb_device_get_connection

---
 src/cairo-xcb-connection.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/src/cairo-xcb-connection.c b/src/cairo-xcb-connection.c
index 95d6b8f..aa60608 100644
--- a/src/cairo-xcb-connection.c
+++ b/src/cairo-xcb-connection.c
@@ -776,6 +776,16 @@ _cairo_xcb_connection_get_xid (cairo_xcb_connection_t *connection)
     return xid;
 }
 
+/**
+ * cairo_xcb_device_get_connection:
+ * @device: a #cairo_device_t for the XCB backend
+ *
+ * Get the connection for the XCB device.
+ *
+ * Returns: the #xcb_connection_t for the connection
+ *
+ * Since: 1.12
+ **/
 xcb_connection_t *
 cairo_xcb_device_get_connection (cairo_device_t *device)
 {
-- 
1.7.2.5

From f348a534879d830f6a4c9073f9c503a0b8f9798d Mon Sep 17 00:00:00 2001
From: Nis Martensen <[email protected]>
Date: Sun, 4 Mar 2012 17:22:56 +0100
Subject: [PATCH 22/25] doc: fix broken link

cairo_win32_scaled_font_create_for_logfontw() does not exist. Probably
cairo_win32_font_face_create_for_logfontw() was meant instead.
---
 src/win32/cairo-win32-font.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/src/win32/cairo-win32-font.c b/src/win32/cairo-win32-font.c
index 014f604..92658ba 100644
--- a/src/win32/cairo-win32-font.c
+++ b/src/win32/cairo-win32-font.c
@@ -2291,7 +2291,7 @@ _cairo_scaled_font_is_win32 (cairo_scaled_font_t *scaled_font)
 /**
  * cairo_win32_scaled_font_select_font:
  * @scaled_font: A #cairo_scaled_font_t from the Win32 font backend. Such an
- *   object can be created with cairo_win32_scaled_font_create_for_logfontw().
+ *   object can be created with cairo_win32_font_face_create_for_logfontw().
  * @hdc: a device context
  *
  * Selects the font into the given device context and changes the
-- 
1.7.2.5