[cogl] docs: make cogl2-clip-state.h docs consistent



commit 36575502e8e10c58671203414215e1028179ca65
Author: Robert Bragg <robert linux intel com>
Date:   Sun Nov 20 19:01:30 2011 +0000

    docs: make cogl2-clip-state.h docs consistent
    
    This updates some of the cogl2-clip-state.h cogl_clip_ API documentation
    to make it consistent with the documentation for corresponding
    framebuffer clip stack API in cogl-framebuffer.h
    
    Reviewed-by: Neil Roberts <neil linux intel com>

 cogl/cogl2-clip-state.h |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)
---
diff --git a/cogl/cogl2-clip-state.h b/cogl/cogl2-clip-state.h
index 9239bb1..63b20ee 100644
--- a/cogl/cogl2-clip-state.h
+++ b/cogl/cogl2-clip-state.h
@@ -37,8 +37,9 @@ G_BEGIN_DECLS
  * cogl_clip_push_from_path:
  * @path: The path to clip with.
  *
- * Sets a new clipping area using @path. The clipping area is intersected
- * with the previous clipping area. To restore the previous clipping area,
+ * Sets a new clipping area using the silhouette of the specified,
+ * filled @path.  The clipping area is intersected with the previous
+ * clipping area. To restore the previous clipping area, call
  * call cogl_clip_pop().
  *
  * Since: 1.8



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]