[cairo-commit] cairo/src cairo-pattern.c, 1.66, 1.67 cairo.c, 1.136, 1.137 cairo.h, 1.153, 1.154

[Billy Biggs]

Committed by: vektor

Update of /cvs/cairo/cairo/src
In directory gabe:/tmp/cvs-serv7342/src

Modified Files:
	cairo-pattern.c cairo.c cairo.h 
Log Message:
2005-10-10  Billy Biggs  <vektor at dumbterm.net>

	* src/cairo.h (cairo_extend_t): Add documentation for the
	extend modes.
	* src/cairo-pattern.c (cairo_pattern_set_extend),
	(cairo_pattern_get_extend): Document the extend functions
	for patterns.
	* src/cairo.c (cairo_copy_path): Remove some redundancy in
	the documentation.



Index: cairo-pattern.c
===================================================================
RCS file: /cvs/cairo/cairo/src/cairo-pattern.c,v
retrieving revision 1.66
retrieving revision 1.67
diff -u -d -r1.66 -r1.67
--- cairo-pattern.c	9 Oct 2005 16:18:16 -0000	1.66
+++ cairo-pattern.c	10 Oct 2005 16:16:21 -0000	1.67
@@ -778,6 +778,16 @@
     return pattern->filter;
 }
 
+/**
+ * cairo_pattern_set_extend:
+ * @pattern: a #cairo_pattern_t
+ * @extend: a #cairo_extend_t describing how the area outside of the
+ * pattern will be drawn
+ *
+ * Sets the mode to be used for drawing outside the area of a pattern.
+ * See #cairo_extend_t for details on the semantics of each extend
+ * strategy.
+ **/
 void
 cairo_pattern_set_extend (cairo_pattern_t *pattern, cairo_extend_t extend)
 {
@@ -787,6 +797,16 @@
     pattern->extend = extend;
 }
 
+/**
+ * cairo_pattern_get_extend:
+ * @pattern: a #cairo_pattern_t
+ *
+ * Gets the current extend mode for a pattern.  See #cairo_extend_t
+ * for details on the semantics of each extend strategy.
+ * 
+ * Return value: the current extend strategy used for drawing the
+ * pattern.
+ **/
 cairo_extend_t
 cairo_pattern_get_extend (cairo_pattern_t *pattern)
 {

Index: cairo.c
===================================================================
RCS file: /cvs/cairo/cairo/src/cairo.c,v
retrieving revision 1.136
retrieving revision 1.137
diff -u -d -r1.136 -r1.137
--- cairo.c	24 Aug 2005 13:09:11 -0000	1.136
+++ cairo.c	10 Oct 2005 16:16:21 -0000	1.137
@@ -2409,10 +2409,6 @@
  * #cairo_path_t. See #cairo_path_data_t for hints on how to iterate
  * over the returned data structure.
  * 
- * Return value: the copy of the current path. The caller owns the
- * returned object and should call cairo_path_destroy() when finished
- * with it.
- *
  * This function will always return a valid pointer, but the result
  * will have no data (<literal>data==NULL</literal> and
  * <literal>num_data==0</literal>), if either of the following

Index: cairo.h
===================================================================
RCS file: /cvs/cairo/cairo/src/cairo.h,v
retrieving revision 1.153
retrieving revision 1.154
diff -u -d -r1.153 -r1.154
--- cairo.h	9 Oct 2005 16:18:16 -0000	1.153
+++ cairo.h	10 Oct 2005 16:16:21 -0000	1.154
@@ -1289,6 +1289,19 @@
 cairo_pattern_get_matrix (cairo_pattern_t *pattern,
 			  cairo_matrix_t  *matrix);
 
+/**
+ * cairo_extend_t
+ * @CAIRO_EXTEND_NONE: pixels outside of the source pattern
+ *   are fully transparent
+ * @CAIRO_EXTEND_REPEAT: the pattern is tiled by repeating
+ * @CAIRO_EXTEND_REFLECT: the pattern is tiled by reflecting
+ *   at the edges
+ * @CAIRO_EXTEND_NEAREST: pixels outside of the pattern copy
+ *   the closest pixel from the source (since cairo 1.2)
+ *
+ * #cairo_extend_t is used to describe how the area outside
+ * of a pattern will be drawn.
+ */
 typedef enum _cairo_extend {
     CAIRO_EXTEND_NONE,
     CAIRO_EXTEND_REPEAT,