diff options
| author | Damien Lespiau <damien.lespiau@intel.com> | 2012-12-29 19:17:35 +0000 |
|---|---|---|
| committer | Robert Bragg <robert@linux.intel.com> | 2013-01-22 17:48:11 +0000 |
| commit | 7b43289ec95a5e032901922bcc49dde3ce225dbb (patch) | |
| tree | fe7e2207eedf228795733877cfc708114eb0de00 /cogl | |
| parent | f51f2459ac3b2000f645e01b65cda1e6facea2be (diff) | |
| download | cogl-7b43289ec95a5e032901922bcc49dde3ce225dbb.tar.gz | |
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)
Diffstat (limited to 'cogl')
| -rw-r--r-- | cogl/cogl-matrix.h | 2 | ||||
| -rw-r--r-- | 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 7525f8fe..094de207 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 b6841f69..c2553486 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 |