From 7b43289ec95a5e032901922bcc49dde3ce225dbb Mon Sep 17 00:00:00 2001 From: Damien Lespiau Date: Sat, 29 Dec 2012 19:17:35 +0000 Subject: [PATCH] doc: Use Returns: to annotate return values 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 (cherry picked from commit 9718f31717b3a0e01b7c4c69cea138f39d23c0e0) --- 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 7525f8fed..094de2079 100644 --- a/cogl/cogl-matrix.h +++ b/cogl/cogl-matrix.h @@ -783,7 +783,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 b6841f696..c25534862 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