[PATCH 11/25] doc: symbol names in header and comment must match

Nis Martensen nis.martensen at web.de
Sat Mar 3 14:31:25 PST 2012


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


--------------090104080009020304000505
Content-Type: text/plain;
 name="0012-doc-ensure-compatibility-spelling.patch.txt"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
 filename="0012-doc-ensure-compatibility-spelling.patch.txt"



More information about the cairo mailing list