cairo-xcb: gtk-doc doesn't like _ in parameter names

Any function documented with gtk-doc must not have _ in any parameter
names, or at least that's what I've found. This patch simply renames
parameters as needed to make things work.

Signed-off-by: Keith Packard <keithp@keithp.com>
Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
This commit is contained in:
Keith Packard 2011-12-02 14:57:22 +00:00 committed by Chris Wilson
parent a6def3874c
commit d5c7d2e2f4

View file

@ -1149,7 +1149,7 @@ _cairo_xcb_screen_from_visual (xcb_connection_t *connection,
/** /**
* cairo_xcb_surface_create: * cairo_xcb_surface_create:
* @xcb_connection: an XCB connection * @connection: an XCB connection
* @drawable: an XCB drawable * @drawable: an XCB drawable
* @visual: the visual to use for drawing to @drawable. The depth * @visual: the visual to use for drawing to @drawable. The depth
* of the visual must match the depth of the drawable. * of the visual must match the depth of the drawable.
@ -1179,7 +1179,7 @@ _cairo_xcb_screen_from_visual (xcb_connection_t *connection,
* occurs. You can use cairo_surface_status() to check for this. * occurs. You can use cairo_surface_status() to check for this.
**/ **/
cairo_surface_t * cairo_surface_t *
cairo_xcb_surface_create (xcb_connection_t *xcb_connection, cairo_xcb_surface_create (xcb_connection_t *connection,
xcb_drawable_t drawable, xcb_drawable_t drawable,
xcb_visualtype_t *visual, xcb_visualtype_t *visual,
int width, int width,
@ -1192,7 +1192,7 @@ cairo_xcb_surface_create (xcb_connection_t *xcb_connection,
xcb_render_pictformat_t xrender_format; xcb_render_pictformat_t xrender_format;
int depth; int depth;
if (xcb_connection_has_error (xcb_connection)) if (xcb_connection_has_error (connection))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_WRITE_ERROR)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_WRITE_ERROR));
if (unlikely (width > XLIB_COORD_MAX || height > XLIB_COORD_MAX)) if (unlikely (width > XLIB_COORD_MAX || height > XLIB_COORD_MAX))
@ -1200,7 +1200,7 @@ cairo_xcb_surface_create (xcb_connection_t *xcb_connection,
if (unlikely (width <= 0 || height <= 0)) if (unlikely (width <= 0 || height <= 0))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_SIZE)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_SIZE));
xcb_screen = _cairo_xcb_screen_from_visual (xcb_connection, visual, &depth); xcb_screen = _cairo_xcb_screen_from_visual (connection, visual, &depth);
if (unlikely (xcb_screen == NULL)) if (unlikely (xcb_screen == NULL))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_VISUAL)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_VISUAL));
@ -1223,7 +1223,7 @@ cairo_xcb_surface_create (xcb_connection_t *xcb_connection,
if (! _pixman_format_from_masks (&image_masks, &pixman_format)) if (! _pixman_format_from_masks (&image_masks, &pixman_format))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_FORMAT)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_FORMAT));
screen = _cairo_xcb_screen_get (xcb_connection, xcb_screen); screen = _cairo_xcb_screen_get (connection, xcb_screen);
if (unlikely (screen == NULL)) if (unlikely (screen == NULL))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY));
@ -1242,11 +1242,11 @@ slim_hidden_def (cairo_xcb_surface_create);
/** /**
* cairo_xcb_surface_create_for_bitmap: * cairo_xcb_surface_create_for_bitmap:
* @xcb_connection: an XCB connection * @connection: an XCB connection
* @xcb_screen: the XCB screen associated with @bitmap * @screen: the XCB screen associated with @bitmap
* @bitmap: an XCB drawable (a Pixmap with depth 1) * @bitmap: an XCB drawable (a Pixmap with depth 1)
* @width: the current width of @drawable * @width: the current width of @bitmap
* @height: the current height of @drawable * @height: the current height of @bitmap
* *
* Creates an XCB surface that draws to the given bitmap. * Creates an XCB surface that draws to the given bitmap.
* This will be drawn to as a %CAIRO_FORMAT_A1 object. * This will be drawn to as a %CAIRO_FORMAT_A1 object.
@ -1260,15 +1260,15 @@ slim_hidden_def (cairo_xcb_surface_create);
* occurs. You can use cairo_surface_status() to check for this. * occurs. You can use cairo_surface_status() to check for this.
**/ **/
cairo_surface_t * cairo_surface_t *
cairo_xcb_surface_create_for_bitmap (xcb_connection_t *xcb_connection, cairo_xcb_surface_create_for_bitmap (xcb_connection_t *connection,
xcb_screen_t *xcb_screen, xcb_screen_t *screen,
xcb_pixmap_t bitmap, xcb_pixmap_t bitmap,
int width, int width,
int height) int height)
{ {
cairo_xcb_screen_t *screen; cairo_xcb_screen_t *cairo_xcb_screen;
if (xcb_connection_has_error (xcb_connection)) if (xcb_connection_has_error (connection))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_WRITE_ERROR)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_WRITE_ERROR));
if (width > XLIB_COORD_MAX || height > XLIB_COORD_MAX) if (width > XLIB_COORD_MAX || height > XLIB_COORD_MAX)
@ -1276,13 +1276,13 @@ cairo_xcb_surface_create_for_bitmap (xcb_connection_t *xcb_connection,
if (unlikely (width <= 0 || height <= 0)) if (unlikely (width <= 0 || height <= 0))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_SIZE)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_SIZE));
screen = _cairo_xcb_screen_get (xcb_connection, xcb_screen); cairo_xcb_screen = _cairo_xcb_screen_get (connection, screen);
if (unlikely (screen == NULL)) if (unlikely (cairo_xcb_screen == NULL))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY));
return _cairo_xcb_surface_create_internal (screen, bitmap, FALSE, return _cairo_xcb_surface_create_internal (cairo_xcb_screen, bitmap, FALSE,
PIXMAN_a1, PIXMAN_a1,
screen->connection->standard_formats[CAIRO_FORMAT_A1], cairo_xcb_screen->connection->standard_formats[CAIRO_FORMAT_A1],
width, height); width, height);
} }
#if CAIRO_HAS_XLIB_XCB_FUNCTIONS #if CAIRO_HAS_XLIB_XCB_FUNCTIONS
@ -1321,18 +1321,18 @@ slim_hidden_def (cairo_xcb_surface_create_for_bitmap);
* occurs. You can use cairo_surface_status() to check for this. * occurs. You can use cairo_surface_status() to check for this.
**/ **/
cairo_surface_t * cairo_surface_t *
cairo_xcb_surface_create_with_xrender_format (xcb_connection_t *xcb_connection, cairo_xcb_surface_create_with_xrender_format (xcb_connection_t *connection,
xcb_screen_t *xcb_screen, xcb_screen_t *screen,
xcb_drawable_t drawable, xcb_drawable_t drawable,
xcb_render_pictforminfo_t *format, xcb_render_pictforminfo_t *format,
int width, int width,
int height) int height)
{ {
cairo_xcb_screen_t *screen; cairo_xcb_screen_t *cairo_xcb_screen;
cairo_format_masks_t image_masks; cairo_format_masks_t image_masks;
pixman_format_code_t pixman_format; pixman_format_code_t pixman_format;
if (xcb_connection_has_error (xcb_connection)) if (xcb_connection_has_error (connection))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_WRITE_ERROR)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_WRITE_ERROR));
if (width > XLIB_COORD_MAX || height > XLIB_COORD_MAX) if (width > XLIB_COORD_MAX || height > XLIB_COORD_MAX)
@ -1364,11 +1364,11 @@ cairo_xcb_surface_create_with_xrender_format (xcb_connection_t *xcb_connecti
if (! _pixman_format_from_masks (&image_masks, &pixman_format)) if (! _pixman_format_from_masks (&image_masks, &pixman_format))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_FORMAT)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_INVALID_FORMAT));
screen = _cairo_xcb_screen_get (xcb_connection, xcb_screen); cairo_xcb_screen = _cairo_xcb_screen_get (connection, screen);
if (unlikely (screen == NULL)) if (unlikely (cairo_xcb_screen == NULL))
return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY)); return _cairo_surface_create_in_error (_cairo_error (CAIRO_STATUS_NO_MEMORY));
return _cairo_xcb_surface_create_internal (screen, return _cairo_xcb_surface_create_internal (cairo_xcb_screen,
drawable, drawable,
FALSE, FALSE,
pixman_format, pixman_format,