brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Use Returns: to annotate return values

Browse Source 
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)
This commit is contained in:
Damien Lespiau 2012-12-29 19:17:35 +00:00 committed by Robert Bragg
parent f51f2459ac
commit 7b43289ec9
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cogl/cogl-matrix.h
View File

@ -783,7 +783,7 @@ cogl_debug_matrix_print (const CoglMatrix *matrix);
/** /**
* cogl_gtype_matrix_get_type: * 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 * can be used for example to define GObject properties that accept a
* #CoglMatrix value. * #CoglMatrix value.
*/ */

2
cogl/cogl-sdl.h
View File

@ -209,7 +209,7 @@ cogl_sdl_idle (CoglContext *context);
* cogl_sdl_onscreen_get_window: * cogl_sdl_onscreen_get_window:
* @onscreen: A #CoglOnscreen * @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 * Since: 2.0
* Stability: unstable * Stability: unstable