docs: make cogl.h clip stack docs consistent

This updates some of the cogl.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>
This commit is contained in:
Robert Bragg 2011-11-20 19:00:38 +00:00
parent 6bb409e996
commit de04a58f30

View File

@ -1032,8 +1032,10 @@ cogl_clip_push_from_path_preserve (void);
* to be larger than the true bounds but behaviour is undefined if the
* bounds are smaller than the true bounds.
*
* The clipping area is intersected with the previous clipping area.
* To restore the previous clipping area, call cogl_clip_pop().
* The primitive is transformed by the current model-view matrix and
* the silhouette is intersected with the previous clipping area. To
* restore the previous clipping area, call
* cogl_clip_pop().
*
* Since: 1.10
* Stability: unstable