[cairo-commit] 2 commits - doc/public src/cairo.c
Carl Worth
cworth at kemper.freedesktop.org
Fri Sep 29 16:56:39 PDT 2006
doc/public/tmpl/cairo-image.sgml | 1
doc/public/tmpl/cairo-status.sgml | 48 ++++++++-------
doc/public/tmpl/cairo-surface.sgml | 112 ++++++++++++++++++-------------------
src/cairo.c | 32 ++++++----
4 files changed, 102 insertions(+), 91 deletions(-)
New commits:
diff-tree beb778f482645650b129762a0a37400c12a04b32 (from 516ca57dd835da17fb6b43f00d1b1f37f25f49c4)
Author: Carl Worth <cworth at cworth.org>
Date: Fri Sep 29 16:56:36 2006 -0700
Use consistent wording to document cairo_in_fill, cairo_in_stroke, cairo_fill_extents, and cairo_stroke_extents.
diff --git a/src/cairo.c b/src/cairo.c
index aab6705..cda9b0e 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -2008,8 +2008,8 @@ cairo_show_page (cairo_t *cr)
* @y: Y coordinate of the point to test
*
* Tests whether the given point is inside the area that would be
- * stroked by doing a cairo_stroke() operation on @cr given the
- * current path and stroking parameters.
+ * affected by a cairo_stroke() operation given the current path and
+ * stroking parameters.
*
* See cairo_stroke(), cairo_set_line_width(), cairo_set_line_join(),
* cairo_set_line_cap(), cairo_set_dash(), and
@@ -2042,8 +2042,8 @@ cairo_in_stroke (cairo_t *cr, double x,
* @y: Y coordinate of the point to test
*
* Tests whether the given point is inside the area that would be
- * filled by doing a cairo_fill() operation on @cr given the current
- * path and filling parameters.
+ * affected by a cairo_fill() operation given the current path and
+ * filling parameters.
*
* See cairo_fill(), cairo_set_fill_rule() and cairo_fill_preserve().
*
@@ -2077,10 +2077,15 @@ cairo_in_fill (cairo_t *cr, double x, do
* @x2: right of the resulting extents
* @y2: bottom of the resulting extents
*
- * Computes a bounding box in user coordinates covering all area that will
- * be stroked by the current path with the current stroking parameters. If
- * the current path is empty, returns an empty rectangle. Surface dimensions
- * and clipping are not taken into account.
+ * Computes a bounding box in user coordinates covering the area that
+ * would be affected by a cairo_stroke() operation operation given the
+ * current path and stroke parameters. If the current path is empty,
+ * returns an empty rectangle (0,0, 0,0). Surface dimensions and
+ * clipping are not taken into account.
+ *
+ * See cairo_stroke(), cairo_set_line_width(), cairo_set_line_join(),
+ * cairo_set_line_cap(), cairo_set_dash(), and
+ * cairo_stroke_preserve().
**/
void
cairo_stroke_extents (cairo_t *cr,
@@ -2104,10 +2109,13 @@ cairo_stroke_extents (cairo_t *cr,
* @x2: right of the resulting extents
* @y2: bottom of the resulting extents
*
- * Computes a bounding box in user coordinates covering all area that will
- * be filled by the current path. If the current path is empty, returns an
- * empty rectangle. Surface dimensions and clipping are not taken into
- * account.
+ * Computes a bounding box in user coordinates covering the area that
+ * would be affected by a cairo_fill() operation given the current path
+ * and fill parameters. If the current path is empty, returns an empty
+ * rectangle (0,0, 0,0). Surface dimensions and clipping are not taken
+ * into account.
+ *
+ * See cairo_fill(), cairo_set_fill_rule() and cairo_fill_preserve().
**/
void
cairo_fill_extents (cairo_t *cr,
diff-tree 516ca57dd835da17fb6b43f00d1b1f37f25f49c4 (from b99d41a0b075ec405d14ea8b6bbcaa50aa35e890)
Author: Carl Worth <cworth at cworth.org>
Date: Fri Sep 29 16:55:22 2006 -0700
tmpl: obnoxious churn
diff --git a/doc/public/tmpl/cairo-image.sgml b/doc/public/tmpl/cairo-image.sgml
index 67fc1ff..b72732f 100644
--- a/doc/public/tmpl/cairo-image.sgml
+++ b/doc/public/tmpl/cairo-image.sgml
@@ -29,7 +29,6 @@ Rendering to memory buffers
@CAIRO_FORMAT_RGB24:
@CAIRO_FORMAT_A8:
@CAIRO_FORMAT_A1:
- at CAIRO_FORMAT_RGB16_565:
<!-- ##### FUNCTION cairo_image_surface_create ##### -->
<para>
diff --git a/doc/public/tmpl/cairo-status.sgml b/doc/public/tmpl/cairo-status.sgml
index 0996e29..f943cac 100644
--- a/doc/public/tmpl/cairo-status.sgml
+++ b/doc/public/tmpl/cairo-status.sgml
@@ -22,35 +22,37 @@ Decoding cairo's status
</para>
- at CAIRO_STATUS_SUCCESS:
- at CAIRO_STATUS_NO_MEMORY:
- at CAIRO_STATUS_INVALID_RESTORE:
- at CAIRO_STATUS_INVALID_POP_GROUP:
- at CAIRO_STATUS_NO_CURRENT_POINT:
- at CAIRO_STATUS_INVALID_MATRIX:
- at CAIRO_STATUS_INVALID_STATUS:
- at CAIRO_STATUS_NULL_POINTER:
- at CAIRO_STATUS_INVALID_STRING:
- at CAIRO_STATUS_INVALID_PATH_DATA:
- at CAIRO_STATUS_READ_ERROR:
- at CAIRO_STATUS_WRITE_ERROR:
- at CAIRO_STATUS_SURFACE_FINISHED:
- at CAIRO_STATUS_SURFACE_TYPE_MISMATCH:
- at CAIRO_STATUS_PATTERN_TYPE_MISMATCH:
- at CAIRO_STATUS_INVALID_CONTENT:
- at CAIRO_STATUS_INVALID_FORMAT:
- at CAIRO_STATUS_INVALID_VISUAL:
- at CAIRO_STATUS_FILE_NOT_FOUND:
- at CAIRO_STATUS_INVALID_DASH:
- at CAIRO_STATUS_INVALID_DSC_COMMENT:
+ at CAIRO_STATUS_SUCCESS:
+ at CAIRO_STATUS_NO_MEMORY:
+ at CAIRO_STATUS_INVALID_RESTORE:
+ at CAIRO_STATUS_INVALID_POP_GROUP:
+ at CAIRO_STATUS_NO_CURRENT_POINT:
+ at CAIRO_STATUS_INVALID_MATRIX:
+ at CAIRO_STATUS_INVALID_STATUS:
+ at CAIRO_STATUS_NULL_POINTER:
+ at CAIRO_STATUS_INVALID_STRING:
+ at CAIRO_STATUS_INVALID_PATH_DATA:
+ at CAIRO_STATUS_READ_ERROR:
+ at CAIRO_STATUS_WRITE_ERROR:
+ at CAIRO_STATUS_SURFACE_FINISHED:
+ at CAIRO_STATUS_SURFACE_TYPE_MISMATCH:
+ at CAIRO_STATUS_PATTERN_TYPE_MISMATCH:
+ at CAIRO_STATUS_INVALID_CONTENT:
+ at CAIRO_STATUS_INVALID_FORMAT:
+ at CAIRO_STATUS_INVALID_VISUAL:
+ at CAIRO_STATUS_FILE_NOT_FOUND:
+ at CAIRO_STATUS_INVALID_DASH:
+ at CAIRO_STATUS_INVALID_DSC_COMMENT:
+ at CAIRO_STATUS_INVALID_INDEX:
+ at CAIRO_STATUS_CLIP_NOT_REPRESENTABLE:
<!-- ##### FUNCTION cairo_status_to_string ##### -->
<para>
</para>
- at status:
- at Returns:
+ at status:
+ at Returns:
<!-- ##### FUNCTION cairo_debug_reset_static_data ##### -->
diff --git a/doc/public/tmpl/cairo-surface.sgml b/doc/public/tmpl/cairo-surface.sgml
index 3d76c41..d993636 100644
--- a/doc/public/tmpl/cairo-surface.sgml
+++ b/doc/public/tmpl/cairo-surface.sgml
@@ -28,20 +28,20 @@ Base class for surfaces
</para>
- at CAIRO_CONTENT_COLOR:
- at CAIRO_CONTENT_ALPHA:
- at CAIRO_CONTENT_COLOR_ALPHA:
+ at CAIRO_CONTENT_COLOR:
+ at CAIRO_CONTENT_ALPHA:
+ at CAIRO_CONTENT_COLOR_ALPHA:
<!-- ##### FUNCTION cairo_surface_create_similar ##### -->
<para>
</para>
- at other:
- at content:
- at width:
- at height:
- at Returns:
+ at other:
+ at content:
+ at width:
+ at height:
+ at Returns:
<!-- ##### FUNCTION cairo_surface_destroy ##### -->
@@ -49,7 +49,7 @@ Base class for surfaces
</para>
- at surface:
+ at surface:
<!-- ##### FUNCTION cairo_surface_finish ##### -->
@@ -57,7 +57,7 @@ Base class for surfaces
</para>
- at surface:
+ at surface:
<!-- ##### FUNCTION cairo_surface_flush ##### -->
@@ -65,7 +65,7 @@ Base class for surfaces
</para>
- at surface:
+ at surface:
<!-- ##### FUNCTION cairo_surface_get_font_options ##### -->
@@ -73,8 +73,8 @@ Base class for surfaces
</para>
- at surface:
- at options:
+ at surface:
+ at options:
<!-- ##### FUNCTION cairo_surface_get_content ##### -->
@@ -82,8 +82,8 @@ Base class for surfaces
</para>
- at surface:
- at Returns:
+ at surface:
+ at Returns:
<!-- ##### FUNCTION cairo_surface_set_user_data ##### -->
@@ -91,11 +91,11 @@ Base class for surfaces
</para>
- at surface:
- at key:
- at user_data:
- at destroy:
- at Returns:
+ at surface:
+ at key:
+ at user_data:
+ at destroy:
+ at Returns:
<!-- ##### FUNCTION cairo_surface_get_user_data ##### -->
@@ -103,9 +103,9 @@ Base class for surfaces
</para>
- at surface:
- at key:
- at Returns:
+ at surface:
+ at key:
+ at Returns:
<!-- ##### FUNCTION cairo_surface_mark_dirty ##### -->
@@ -113,7 +113,7 @@ Base class for surfaces
</para>
- at surface:
+ at surface:
<!-- ##### FUNCTION cairo_surface_mark_dirty_rectangle ##### -->
@@ -121,11 +121,11 @@ Base class for surfaces
</para>
- at surface:
- at x:
- at y:
- at width:
- at height:
+ at surface:
+ at x:
+ at y:
+ at width:
+ at height:
<!-- ##### FUNCTION cairo_surface_reference ##### -->
@@ -133,8 +133,8 @@ Base class for surfaces
</para>
- at surface:
- at Returns:
+ at surface:
+ at Returns:
<!-- ##### FUNCTION cairo_surface_set_device_offset ##### -->
@@ -142,9 +142,9 @@ Base class for surfaces
</para>
- at surface:
- at x_offset:
- at y_offset:
+ at surface:
+ at x_offset:
+ at y_offset:
<!-- ##### FUNCTION cairo_surface_get_device_offset ##### -->
@@ -152,9 +152,9 @@ Base class for surfaces
</para>
- at surface:
- at x_offset:
- at y_offset:
+ at surface:
+ at x_offset:
+ at y_offset:
<!-- ##### FUNCTION cairo_surface_set_fallback_resolution ##### -->
@@ -162,9 +162,9 @@ Base class for surfaces
</para>
- at surface:
- at x_pixels_per_inch:
- at y_pixels_per_inch:
+ at surface:
+ at x_pixels_per_inch:
+ at y_pixels_per_inch:
<!-- ##### FUNCTION cairo_surface_status ##### -->
@@ -172,8 +172,8 @@ Base class for surfaces
</para>
- at surface:
- at Returns:
+ at surface:
+ at Returns:
<!-- ##### ENUM cairo_surface_type_t ##### -->
@@ -181,24 +181,26 @@ Base class for surfaces
</para>
- at CAIRO_SURFACE_TYPE_IMAGE:
- at CAIRO_SURFACE_TYPE_PDF:
- at CAIRO_SURFACE_TYPE_PS:
- at CAIRO_SURFACE_TYPE_XLIB:
- at CAIRO_SURFACE_TYPE_XCB:
- at CAIRO_SURFACE_TYPE_GLITZ:
- at CAIRO_SURFACE_TYPE_QUARTZ:
- at CAIRO_SURFACE_TYPE_WIN32:
- at CAIRO_SURFACE_TYPE_BEOS:
- at CAIRO_SURFACE_TYPE_DIRECTFB:
- at CAIRO_SURFACE_TYPE_SVG:
+ at CAIRO_SURFACE_TYPE_IMAGE:
+ at CAIRO_SURFACE_TYPE_PDF:
+ at CAIRO_SURFACE_TYPE_PS:
+ at CAIRO_SURFACE_TYPE_XLIB:
+ at CAIRO_SURFACE_TYPE_XCB:
+ at CAIRO_SURFACE_TYPE_GLITZ:
+ at CAIRO_SURFACE_TYPE_QUARTZ:
+ at CAIRO_SURFACE_TYPE_WIN32:
+ at CAIRO_SURFACE_TYPE_BEOS:
+ at CAIRO_SURFACE_TYPE_DIRECTFB:
+ at CAIRO_SURFACE_TYPE_SVG:
+ at CAIRO_SURFACE_TYPE_NQUARTZ:
+ at CAIRO_SURFACE_TYPE_OS2:
<!-- ##### FUNCTION cairo_surface_get_type ##### -->
<para>
</para>
- at surface:
- at Returns:
+ at surface:
+ at Returns:
More information about the cairo-commit
mailing list