Add documentation for the extend modes.

Document the extend functions for patterns.
Remove some redundancy in the documentation.

ChangeLog

@@ -1,3 +1,13 @@
+2005-10-10  Billy Biggs  <vektor@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.
+
 2005-10-09  Keith Packard  <keithp@keithp.com>
 
 	reviewed by: cworth

src/cairo-pattern.c

@@ -778,6 +778,16 @@ cairo_pattern_get_filter (cairo_pattern_t *pattern)
     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 @@ cairo_pattern_set_extend (cairo_pattern_t *pattern, cairo_extend_t extend)
     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)
 {

src/cairo.c

@@ -2409,10 +2409,6 @@ cairo_get_target (cairo_t *cr)
  * #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

src/cairo.h

@@ -1289,6 +1289,19 @@ cairo_public void
 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,