isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-25 17:40:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc: Use Docbook's <constant> for external constants

Browse Source 
For external (non gtk-doc even) constants, we can use <constant> to
correctly tag those without gtk-doc trying to cross-reference them.

(cherry picked from commit 78d22c6cd44a2279adcd2b94c3317292af861c70)
This commit is contained in:
Damien Lespiau 2012-12-31 22:08:44 +00:00 committed by Robert Bragg
parent 58680d3a4f
commit 4316c3c9e1
2 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cogl/cogl-sdl.h
View File

@ -98,8 +98,8 @@ COGL_BEGIN_DECLS
/**
* cogl_sdl_context_new:
* @type: An SDL user event type between %SDL_USEREVENT and
* %SDL_NUMEVENTS - %1
* @type: An SDL user event type between <constant>SDL_USEREVENT</constant> and
* <constant>SDL_NUMEVENTS</constant> - 1
* @error: A CoglError return location.
*
* This is a convenience function for creating a new #CoglContext for
@ -138,8 +138,8 @@ cogl_sdl_context_new (int type, CoglError **error);
/**
* cogl_sdl_renderer_set_event_type:
* @renderer: A #CoglRenderer
* @type: An SDL user event type between %SDL_USEREVENT and
* %SDL_NUMEVENTS - %1
* @type: An SDL user event type between <constant>SDL_USEREVENT</constant> and
* <constant>SDL_NUMEVENTS</constant> - 1
*
* Tells Cogl what SDL user event type it can use as a way to
* interrupt SDL_WaitEvent() to ensure that cogl_sdl_handle_event()

19
cogl/cogl-types.h
View File

@ -700,13 +700,18 @@ typedef enum {
/**
* CoglVerticesMode:
* @COGL_VERTICES_MODE_POINTS: FIXME, equivalent to %GL_POINTS
* @COGL_VERTICES_MODE_LINES: FIXME, equivalent to %GL_LINES
* @COGL_VERTICES_MODE_LINE_LOOP: FIXME, equivalent to %GL_LINE_LOOP
* @COGL_VERTICES_MODE_LINE_STRIP: FIXME, equivalent to %GL_LINE_STRIP
* @COGL_VERTICES_MODE_TRIANGLES: FIXME, equivalent to %GL_TRIANGLES
* @COGL_VERTICES_MODE_TRIANGLE_STRIP: FIXME, equivalent to %GL_TRIANGLE_STRIP
* @COGL_VERTICES_MODE_TRIANGLE_FAN: FIXME, equivalent to %GL_TRIANGLE_FAN
* @COGL_VERTICES_MODE_POINTS: FIXME, equivalent to
* <constant>GL_POINTS</constant>
* @COGL_VERTICES_MODE_LINES: FIXME, equivalent to <constant>GL_LINES</constant>
* @COGL_VERTICES_MODE_LINE_LOOP: FIXME, equivalent to
* <constant>GL_LINE_LOOP</constant>
* @COGL_VERTICES_MODE_LINE_STRIP: FIXME, equivalent to
* <constant>GL_LINE_STRIP</constant>
* @COGL_VERTICES_MODE_TRIANGLES: FIXME, equivalent to
* <constant>GL_TRIANGLES</constant>
* @COGL_VERTICES_MODE_TRIANGLE_STRIP: FIXME, equivalent to
* <constant>GL_TRIANGLE_STRIP</constant>
* @COGL_VERTICES_MODE_TRIANGLE_FAN: FIXME, equivalent to <constant>GL_TRIANGLE_FAN</constant>
*
* Different ways of interpreting vertices when drawing.
*