[cogl/wip/cogl-1.14: 151/177] doc: Use Docbook's <constant> for external constants



commit 05192b47beb04bfa1e9cd9b9945017a59873296b
Author: Damien Lespiau <damien lespiau intel com>
Date:   Mon Dec 31 22:08:44 2012 +0000

    doc: Use Docbook's <constant> for external constants
    
    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)

 cogl/cogl-sdl.h   |    8 ++++----
 cogl/cogl-types.h |   19 ++++++++++++-------
 2 files changed, 16 insertions(+), 11 deletions(-)
---
diff --git a/cogl/cogl-sdl.h b/cogl/cogl-sdl.h
index c255348..486732e 100644
--- a/cogl/cogl-sdl.h
+++ b/cogl/cogl-sdl.h
@@ -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()
diff --git a/cogl/cogl-types.h b/cogl/cogl-types.h
index f23b102..fa1f1f9 100644
--- a/cogl/cogl-types.h
+++ b/cogl/cogl-types.h
@@ -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.
  *



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]