[PATCH 05/12] doc: Make doc ids more consistent my always putting ':' after them
Andrea Canciani <[email protected]>
| Newsgroups | gmane.comp.lib.cairo |
|---|---|
| Message-ID | <[email protected]> |
This makes the documentations comments more consistent and fixes many
reports of 'invalid doc id'.
---
src/cairo-arc.c | 2 +-
src/cairo-gstate.c | 2 +-
src/cairo-path-stroke.c | 2 +-
src/cairo-pattern.c | 36 ++++++++++++++++++------------------
src/cairo-quartz-font.c | 4 ++--
src/cairo-quartz-surface.c | 6 +++---
src/cairo-recording-surface.c | 2 +-
src/cairo-surface-snapshot.c | 2 +-
src/cairo-surface.c | 2 +-
src/cairo.c | 8 ++++----
src/win32/cairo-win32-surface.c | 4 ++--
11 files changed, 35 insertions(+), 35 deletions(-)
diff --git a/src/cairo-arc.c b/src/cairo-arc.c
index 6977e88..4113ef9 100644
--- a/src/cairo-arc.c
+++ b/src/cairo-arc.c
@@ -246,7 +246,7 @@ _cairo_arc_in_direction (cairo_t *cr,
}
/**
- * _cairo_arc_path
+ * _cairo_arc_path:
* @cr: a cairo context
* @xc: X position of the center of the arc
* @yc: Y position of the center of the arc
diff --git a/src/cairo-gstate.c b/src/cairo-gstate.c
index a2ec371..d851f34 100644
--- a/src/cairo-gstate.c
+++ b/src/cairo-gstate.c
@@ -328,7 +328,7 @@ _cairo_gstate_redirect_target (cairo_gstate_t *gstate, cairo_surface_t *child)
}
/**
- * _cairo_gstate_is_group
+ * _cairo_gstate_is_group:
* @gstate: a #cairo_gstate_t
*
* Check if _cairo_gstate_redirect_target has been called on the head
diff --git a/src/cairo-path-stroke.c b/src/cairo-path-stroke.c
index 2d32b91..d93be8f 100644
--- a/src/cairo-path-stroke.c
+++ b/src/cairo-path-stroke.c
@@ -180,7 +180,7 @@ _cairo_stroker_join_is_clockwise (const cairo_stroke_face_t *in,
}
/**
- * _cairo_slope_compare_sgn
+ * _cairo_slope_compare_sgn:
*
* Return -1, 0 or 1 depending on the relative slopes of
* two lines.
diff --git a/src/cairo-pattern.c b/src/cairo-pattern.c
index c4e6d31..9f93e91 100644
--- a/src/cairo-pattern.c
+++ b/src/cairo-pattern.c
@@ -2582,7 +2582,7 @@ _cairo_radial_pattern_box_to_parameter (const cairo_radial_pattern_t *radial,
}
/**
- * _cairo_gradient_pattern_box_to_parameter
+ * _cairo_gradient_pattern_box_to_parameter:
*
* Compute a interpolation range sufficient to draw (within the given
* tolerance) the gradient in the given box getting the same result as
@@ -2614,7 +2614,7 @@ _cairo_gradient_pattern_box_to_parameter (const cairo_gradient_pattern_t *gradie
}
/**
- * _cairo_gradient_pattern_interpolate
+ * _cairo_gradient_pattern_interpolate:
*
* Interpolate between the start and end objects of linear or radial
* gradients. The interpolated object is stored in out_circle, with
@@ -2647,7 +2647,7 @@ _cairo_gradient_pattern_interpolate (const cairo_gradient_pattern_t *gradient,
/**
- * _cairo_gradient_pattern_fit_to_range
+ * _cairo_gradient_pattern_fit_to_range:
*
* Scale the extremes of a gradient to guarantee that the coordinates
* and their deltas are within the range (-max_value, max_value). The
@@ -2886,7 +2886,7 @@ _gradient_color_average (const cairo_gradient_pattern_t *gradient,
}
/**
- * _cairo_pattern_alpha_range
+ * _cairo_pattern_alpha_range:
*
* Convenience function to determine the minimum and maximum alpha in
* the drawn part of a pattern (i.e. ignoring clear parts caused by
@@ -2965,7 +2965,7 @@ _cairo_pattern_alpha_range (const cairo_pattern_t *pattern,
}
/**
- * _cairo_mesh_pattern_coord_box
+ * _cairo_mesh_pattern_coord_box:
*
* Convenience function to determine the range of the coordinates of
* the points used to define the patches of the mesh.
@@ -3022,7 +3022,7 @@ _cairo_mesh_pattern_coord_box (const cairo_mesh_pattern_t *mesh,
}
/**
- * _cairo_gradient_pattern_is_solid
+ * _cairo_gradient_pattern_is_solid:
*
* Convenience function to determine whether a gradient pattern is
* a solid color within the given extents. In this case the color
@@ -3105,7 +3105,7 @@ _mesh_is_clear (const cairo_mesh_pattern_t *mesh)
}
/**
- * _cairo_pattern_is_opaque_solid
+ * _cairo_pattern_is_opaque_solid:
*
* Convenience function to determine whether a pattern is an opaque
* (alpha==1.0) solid color pattern. This is done by testing whether
@@ -3231,7 +3231,7 @@ _gradient_is_opaque (const cairo_gradient_pattern_t *gradient,
}
/**
- * _cairo_pattern_is_opaque
+ * _cairo_pattern_is_opaque:
*
* Convenience function to determine whether a pattern is an opaque
* pattern (of any type). The same caveats that apply to
@@ -3940,7 +3940,7 @@ _cairo_pattern_equal (const cairo_pattern_t *a, const cairo_pattern_t *b)
}
/**
- * cairo_pattern_get_rgba
+ * cairo_pattern_get_rgba:
* @pattern: a #cairo_pattern_t
* @red: return value for red component of color, or %NULL
* @green: return value for green component of color, or %NULL
@@ -3984,7 +3984,7 @@ cairo_pattern_get_rgba (cairo_pattern_t *pattern,
}
/**
- * cairo_pattern_get_surface
+ * cairo_pattern_get_surface:
* @pattern: a #cairo_pattern_t
* @surface: return value for surface of pattern, or %NULL
*
@@ -4017,7 +4017,7 @@ cairo_pattern_get_surface (cairo_pattern_t *pattern,
}
/**
- * cairo_pattern_get_color_stop_rgba
+ * cairo_pattern_get_color_stop_rgba:
* @pattern: a #cairo_pattern_t
* @index: index of the stop to return data for
* @offset: return value for the offset of the stop, or %NULL
@@ -4070,7 +4070,7 @@ cairo_pattern_get_color_stop_rgba (cairo_pattern_t *pattern,
}
/**
- * cairo_pattern_get_color_stop_count
+ * cairo_pattern_get_color_stop_count:
* @pattern: a #cairo_pattern_t
* @count: return value for the number of color stops, or %NULL
*
@@ -4103,7 +4103,7 @@ cairo_pattern_get_color_stop_count (cairo_pattern_t *pattern,
}
/**
- * cairo_pattern_get_linear_points
+ * cairo_pattern_get_linear_points:
* @pattern: a #cairo_pattern_t
* @x0: return value for the x coordinate of the first point, or %NULL
* @y0: return value for the y coordinate of the first point, or %NULL
@@ -4144,7 +4144,7 @@ cairo_pattern_get_linear_points (cairo_pattern_t *pattern,
}
/**
- * cairo_pattern_get_radial_circles
+ * cairo_pattern_get_radial_circles:
* @pattern: a #cairo_pattern_t
* @x0: return value for the x coordinate of the center of the first circle, or %NULL
* @y0: return value for the y coordinate of the center of the first circle, or %NULL
@@ -4192,7 +4192,7 @@ cairo_pattern_get_radial_circles (cairo_pattern_t *pattern,
}
/**
- * cairo_mesh_pattern_get_patch_count
+ * cairo_mesh_pattern_get_patch_count:
* @pattern: a #cairo_pattern_t
* @count: return value for the number patches, or %NULL
*
@@ -4231,7 +4231,7 @@ cairo_mesh_pattern_get_patch_count (cairo_pattern_t *pattern,
slim_hidden_def (cairo_mesh_pattern_get_patch_count);
/**
- * cairo_mesh_pattern_get_path
+ * cairo_mesh_pattern_get_path:
* @pattern: a #cairo_pattern_t
* @patch_num: the patch number to return data for
*
@@ -4319,7 +4319,7 @@ cairo_mesh_pattern_get_path (cairo_pattern_t *pattern,
slim_hidden_def (cairo_mesh_pattern_get_path);
/**
- * cairo_mesh_pattern_get_corner_color_rgba
+ * cairo_mesh_pattern_get_corner_color_rgba:
* @pattern: a #cairo_pattern_t
* @patch_num: the patch number to return data for
* @corner_num: the corner number to return data for
@@ -4387,7 +4387,7 @@ cairo_mesh_pattern_get_corner_color_rgba (cairo_pattern_t *pattern,
slim_hidden_def (cairo_mesh_pattern_get_corner_color_rgba);
/**
- * cairo_mesh_pattern_get_control_point
+ * cairo_mesh_pattern_get_control_point:
* @pattern: a #cairo_pattern_t
* @patch_num: the patch number to return data for
* @point_num: the control point number to return data for
diff --git a/src/cairo-quartz-font.c b/src/cairo-quartz-font.c
index 0336972..f94b491 100644
--- a/src/cairo-quartz-font.c
+++ b/src/cairo-quartz-font.c
@@ -340,7 +340,7 @@ const cairo_font_face_backend_t _cairo_quartz_font_face_backend = {
};
/**
- * cairo_quartz_font_face_create_for_cgfont
+ * cairo_quartz_font_face_create_for_cgfont:
* @font: a #CGFontRef obtained through a method external to cairo.
*
* Creates a new font for the Quartz font backend based on a
@@ -815,7 +815,7 @@ _cairo_quartz_scaled_font_get_cg_font_ref (cairo_scaled_font_t *abstract_font)
*/
/**
- * cairo_quartz_font_face_create_for_atsu_font_id
+ * cairo_quartz_font_face_create_for_atsu_font_id:
* @font_id: an ATSUFontID for the font.
*
* Creates a new font for the Quartz font backend based on an
diff --git a/src/cairo-quartz-surface.c b/src/cairo-quartz-surface.c
index 1141cd5..f806077 100644
--- a/src/cairo-quartz-surface.c
+++ b/src/cairo-quartz-surface.c
@@ -2289,7 +2289,7 @@ _cairo_quartz_surface_create_internal (CGContextRef cgContext,
}
/**
- * cairo_quartz_surface_create_for_cg_context
+ * cairo_quartz_surface_create_for_cg_context:
* @cgContext: the existing CGContext for which to create the surface
* @width: width of the surface, in pixels
* @height: height of the surface, in pixels
@@ -2331,7 +2331,7 @@ cairo_quartz_surface_create_for_cg_context (CGContextRef cgContext,
}
/**
- * cairo_quartz_surface_create
+ * cairo_quartz_surface_create:
* @format: format of pixels in the surface to create
* @width: width of the surface, in pixels
* @height: height of the surface, in pixels
@@ -2441,7 +2441,7 @@ cairo_quartz_surface_create (cairo_format_t format,
}
/**
- * cairo_quartz_surface_get_cg_context
+ * cairo_quartz_surface_get_cg_context:
* @surface: the Cairo Quartz surface
*
* Returns the CGContextRef that the given Quartz surface is backed
diff --git a/src/cairo-recording-surface.c b/src/cairo-recording-surface.c
index 4b42dab..2904c18 100644
--- a/src/cairo-recording-surface.c
+++ b/src/cairo-recording-surface.c
@@ -1089,7 +1089,7 @@ CLEANUP_COMPOSITE:
}
/**
- * _cairo_recording_surface_snapshot
+ * _cairo_recording_surface_snapshot:
* @surface: a #cairo_surface_t which must be a recording surface
*
* Make an immutable copy of @surface. It is an error to call a
diff --git a/src/cairo-surface-snapshot.c b/src/cairo-surface-snapshot.c
index c197e71..a2f2a6c 100644
--- a/src/cairo-surface-snapshot.c
+++ b/src/cairo-surface-snapshot.c
@@ -177,7 +177,7 @@ done:
}
/**
- * _cairo_surface_snapshot
+ * _cairo_surface_snapshot:
* @surface: a #cairo_surface_t
*
* Make an immutable reference to @surface. It is an error to call a
diff --git a/src/cairo-surface.c b/src/cairo-surface.c
index 066c30c..cbc44c2 100644
--- a/src/cairo-surface.c
+++ b/src/cairo-surface.c
@@ -2337,7 +2337,7 @@ _cairo_surface_show_text_glyphs (cairo_surface_t *surface,
}
/**
- * _cairo_surface_set_resolution
+ * _cairo_surface_set_resolution:
* @surface: the surface
* @x_res: x resolution, in dpi
* @y_res: y resolution, in dpi
diff --git a/src/cairo.c b/src/cairo.c
index 08ecff3..1b3bc0e 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -635,7 +635,7 @@ cairo_set_opacity (cairo_t *cr, double opacity)
#endif
/**
- * cairo_set_source_rgb
+ * cairo_set_source_rgb:
* @cr: a cairo context
* @red: red component of color
* @green: green component of color
@@ -746,7 +746,7 @@ cairo_set_source_surface (cairo_t *cr,
slim_hidden_def (cairo_set_source_surface);
/**
- * cairo_set_source
+ * cairo_set_source:
* @cr: a cairo context
* @source: a #cairo_pattern_t to be used as the source for
* subsequent drawing operations.
@@ -2727,7 +2727,7 @@ cairo_set_font_size (cairo_t *cr, double size)
slim_hidden_def (cairo_set_font_size);
/**
- * cairo_set_font_matrix
+ * cairo_set_font_matrix:
* @cr: a #cairo_t
* @matrix: a #cairo_matrix_t describing a transform to be applied to
* the current font.
@@ -2755,7 +2755,7 @@ cairo_set_font_matrix (cairo_t *cr,
slim_hidden_def (cairo_set_font_matrix);
/**
- * cairo_get_font_matrix
+ * cairo_get_font_matrix:
* @cr: a #cairo_t
* @matrix: return value for the matrix
*
diff --git a/src/win32/cairo-win32-surface.c b/src/win32/cairo-win32-surface.c
index 0dcbbf8..ec2dd95 100644
--- a/src/win32/cairo-win32-surface.c
+++ b/src/win32/cairo-win32-surface.c
@@ -138,7 +138,7 @@ _cairo_win32_surface_get_extents (void *abstract_surface,
}
/**
- * cairo_win32_surface_get_dc
+ * cairo_win32_surface_get_dc:
* @surface: a #cairo_surface_t
*
* Returns the HDC associated with this surface, or %NULL if none.
@@ -170,7 +170,7 @@ cairo_win32_surface_get_dc (cairo_surface_t *surface)
}
/**
- * cairo_win32_surface_get_image
+ * cairo_win32_surface_get_image:
* @surface: a #cairo_surface_t
*
* Returns a #cairo_surface_t image surface that refers to the same bits
--
1.7.5.4
--
cairo mailing list
[email protected]
http://lists.cairographics.org/mailman/listinfo/cairo