[cairo-commit] src/cairo-gstate.c src/cairo-os2-surface.c src/cairo-scaled-font.c src/cairo-surface.c src/cairo-unicode.c

[Chris Wilson]

 src/cairo-gstate.c      |    4 ++++
 src/cairo-os2-surface.c |    2 ++
 src/cairo-scaled-font.c |   14 +++++++-------
 src/cairo-surface.c     |    4 +++-
 src/cairo-unicode.c     |    6 ++++--
 5 files changed, 20 insertions(+), 10 deletions(-)

New commits:
commit e9f5ee6efe7725c1e0e32fa9e85cca61ecb93440
Author: Chris Wilson <chris at chris-wilson.co.uk>
Date:   Tue Oct 14 14:42:48 2008 +0100

    [doc] Fix a few gtk-doc errors.
    
    gtk-doc insists on a non-empty long description, even for trivial
    functions that are fully described by their input arguments and return
    value. Grrr.

diff --git a/src/cairo-gstate.c b/src/cairo-gstate.c
index 1034d42..e022efc 100644
--- a/src/cairo-gstate.c
+++ b/src/cairo-gstate.c
@@ -314,6 +314,8 @@ _cairo_gstate_redirect_target (cairo_gstate_t *gstate, cairo_surface_t *child)
  * _cairo_gstate_is_redirected
  * @gstate: a #cairo_gstate_t
  *
+ * This space left intentionally blank.
+ *
  * Return value: %TRUE if the gstate is redirected to a target
  * different than the original, %FALSE otherwise.
  **/
@@ -372,6 +374,8 @@ _cairo_gstate_get_original_target (cairo_gstate_t *gstate)
  * _cairo_gstate_get_clip:
  * @gstate: a #cairo_gstate_t
  *
+ * This space left intentionally blank.
+ *
  * Return value: a pointer to the gstate's #cairo_clip_t structure.
  */
 cairo_clip_t *
diff --git a/src/cairo-os2-surface.c b/src/cairo-os2-surface.c
index 5ec4171..bff649a 100644
--- a/src/cairo-os2-surface.c
+++ b/src/cairo-os2-surface.c
@@ -1208,6 +1208,8 @@ cairo_os2_surface_set_manual_window_refresh (cairo_surface_t *surface,
  * cairo_os2_surface_get_manual_window_refresh:
  * @surface: the cairo surface to query the refresh mode from
  *
+ * This space left intentionally blank.
+ *
  * Return value: current refresh mode of the surface (true by default)
  *
  * Since: 1.4
diff --git a/src/cairo-scaled-font.c b/src/cairo-scaled-font.c
index 584dd4c..bfe076a 100644
--- a/src/cairo-scaled-font.c
+++ b/src/cairo-scaled-font.c
@@ -2253,9 +2253,15 @@ _cairo_scaled_glyph_set_meta_surface (cairo_scaled_glyph_t *scaled_glyph,
  * @index: the glyph to create
  * @info: a #cairo_scaled_glyph_info_t marking which portions of
  * the glyph should be filled in.
- * @scaled_glyph_ret: a #cairo_scaled_glyph_t * where the glyph
+ * @scaled_glyph_ret: a #cairo_scaled_glyph_t where the glyph
  * is returned.
  *
+ * If the desired info is not available, (for example, when trying to
+ * get INFO_PATH with a bitmapped font), this function will return
+ * %CAIRO_INT_STATUS_UNSUPPORTED.
+ *
+ * Note: This function must be called with scaled_font->mutex held.
+ *
  * Returns: a glyph with the requested portions filled in. Glyph
  * lookup is cached and glyph will be automatically freed along
  * with the scaled_font so no explicit free is required.
@@ -2263,12 +2269,6 @@ _cairo_scaled_glyph_set_meta_surface (cairo_scaled_glyph_t *scaled_glyph,
  *  %CAIRO_SCALED_GLYPH_INFO_METRICS - glyph metrics and bounding box
  *  %CAIRO_SCALED_GLYPH_INFO_SURFACE - surface holding glyph image
  *  %CAIRO_SCALED_GLYPH_INFO_PATH - path holding glyph outline in device space
- *
- * If the desired info is not available, (for example, when trying to
- * get INFO_PATH with a bitmapped font), this function will return
- * %CAIRO_INT_STATUS_UNSUPPORTED.
- *
- * Note: This function must be called with scaled_font->mutex held.
  **/
 cairo_int_status_t
 _cairo_scaled_glyph_lookup (cairo_scaled_font_t *scaled_font,
diff --git a/src/cairo-surface.c b/src/cairo-surface.c
index 06bd41b..3f5448e 100644
--- a/src/cairo-surface.c
+++ b/src/cairo-surface.c
@@ -1822,10 +1822,12 @@ slim_hidden_def (cairo_surface_show_page);
  * _cairo_surface_get_current_clip_serial:
  * @surface: the #cairo_surface_t to return the serial number for
  *
+ * This space left intentionally blank.
+ *
  * Returns: the serial number associated with the current
  * clip in the surface.  All gstate functions must
  * verify that the correct clip is set in the surface before
- * invoking any surface drawing function
+ * invoking any surface drawing function.
  */
 unsigned int
 _cairo_surface_get_current_clip_serial (cairo_surface_t *surface)
diff --git a/src/cairo-unicode.c b/src/cairo-unicode.c
index 39d37b8..b1567d4 100644
--- a/src/cairo-unicode.c
+++ b/src/cairo-unicode.c
@@ -230,7 +230,7 @@ _cairo_utf8_get_char_validated (const char *p,
 }
 
 /**
- * _cairo_utf8_to_utf32:
+ * _cairo_utf8_to_ucs4:
  * @str: an UTF-8 string
  * @len: length of @str in bytes, or -1 if it is nul-terminated.
  *   If @len is supplied and the string has an embedded nul
@@ -247,7 +247,7 @@ _cairo_utf8_get_char_validated (const char *p,
  *
  * Return value: %CAIRO_STATUS_SUCCESS if the entire string was
  *   successfully converted. %CAIRO_STATUS_INVALID_STRING if an
- *   an invalid sequence was found.
+ *   invalid sequence was found.
  **/
 cairo_status_t
 _cairo_utf8_to_ucs4 (const char *str,
@@ -302,6 +302,8 @@ _cairo_utf8_to_ucs4 (const char *str,
  * @utf8: buffer to write utf8 string into. Must have at least 4 bytes
  * space available. Or %NULL.
  *
+ * This space left intentionally blank.
+ *
  * Return value: Number of bytes in the utf8 string or 0 if an invalid
  * unicode character
  **/