[Cogl] [PATCH 01/53] doc: Use Returns: to annotate return values

Damien Lespiau damien.lespiau at gmail.com
Tue Jan 1 06:30:37 PST 2013


From: Damien Lespiau <damien.lespiau at intel.com>

gtk-doc complains that having a sentence starting by Return is a bit
ambiguous and it'd rather see 'Returns:' spelled out.

Fixes 2 warnings:

 warning: Free-form return value description in $symbol. Use `Returns:'
 to avoid ambiguities
---
 cogl/cogl-matrix.h |    2 +-
 cogl/cogl-sdl.h    |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/cogl/cogl-matrix.h b/cogl/cogl-matrix.h
index 72ce06d..3284a3b 100644
--- a/cogl/cogl-matrix.h
+++ b/cogl/cogl-matrix.h
@@ -764,7 +764,7 @@ cogl_debug_matrix_print (const CoglMatrix *matrix);
 /**
  * cogl_gtype_matrix_get_type:
  *
- * Returns the GType for the registered "CoglMatrix" boxed type. This
+ * Returns: the GType for the registered "CoglMatrix" boxed type. This
  * can be used for example to define GObject properties that accept a
  * #CoglMatrix value.
  */
diff --git a/cogl/cogl-sdl.h b/cogl/cogl-sdl.h
index b6841f6..c255348 100644
--- a/cogl/cogl-sdl.h
+++ b/cogl/cogl-sdl.h
@@ -209,7 +209,7 @@ cogl_sdl_idle (CoglContext *context);
  * cogl_sdl_onscreen_get_window:
  * @onscreen: A #CoglOnscreen
  *
- * Returns the underlying SDL_Window associated with an onscreen framebuffer.
+ * Returns: the underlying SDL_Window associated with an onscreen framebuffer.
  *
  * Since: 2.0
  * Stability: unstable
-- 
1.7.7.5



More information about the Cogl mailing list