[Cogl] [PATCH 42/53] doc: Fixup type references
Damien Lespiau
damien.lespiau at gmail.com
Tue Jan 1 06:31:18 PST 2013
From: Damien Lespiau <damien.lespiau at intel.com>
gtk-doc needs the types in -sections.txt to be able to do
cross-references. Add all those currently generating warnings.
---
cogl/cogl-onscreen.h | 2 +-
cogl/cogl-texture-2d-sliced.h | 4 +-
cogl/cogl-texture-rectangle.h | 4 +-
doc/reference/cogl2/cogl2-sections.txt | 51 +++++++++++++++++++++++++++++--
4 files changed, 52 insertions(+), 9 deletions(-)
diff --git a/cogl/cogl-onscreen.h b/cogl/cogl-onscreen.h
index b1e07d7..0779475 100644
--- a/cogl/cogl-onscreen.h
+++ b/cogl/cogl-onscreen.h
@@ -247,7 +247,7 @@ cogl_android_onscreen_update_size (CoglOnscreen *onscreen,
/**
* cogl_onscreen_set_swap_throttled:
- * @onscreen: A #CoglOncsreen framebuffer
+ * @onscreen: A #CoglOnscreen framebuffer
* @throttled: Whether swap throttling is wanted or not.
*
* Requests that the given @onscreen framebuffer should have swap buffer
diff --git a/cogl/cogl-texture-2d-sliced.h b/cogl/cogl-texture-2d-sliced.h
index 363d6d8..8d2cc4b 100644
--- a/cogl/cogl-texture-2d-sliced.h
+++ b/cogl/cogl-texture-2d-sliced.h
@@ -101,9 +101,9 @@ cogl_texture_2d_sliced_new_with_size (CoglContext *ctx,
* cogl_is_texture_2d_sliced:
* @object: A #CoglObject pointer
*
- * Gets whether the given object references a #CoglTexture2dSliced.
+ * Gets whether the given object references a #CoglTexture2DSliced.
*
- * Return value: %TRUE if the object references a #CoglTexture2dSliced
+ * Return value: %TRUE if the object references a #CoglTexture2DSliced
* and %FALSE otherwise.
* Since: 1.10
* Stability: unstable
diff --git a/cogl/cogl-texture-rectangle.h b/cogl/cogl-texture-rectangle.h
index 4d801aa..0060cfe 100644
--- a/cogl/cogl-texture-rectangle.h
+++ b/cogl/cogl-texture-rectangle.h
@@ -102,7 +102,7 @@ cogl_is_texture_rectangle (void *object);
* first check for the %COGL_FEATURE_ID_TEXTURE_RECTANGLE feature
* using cogl_has_feature().</note>
*
- * Returns: A pointer to a newly allocated #CoglRectangle texture
+ * Returns: A pointer to a newly allocated #CoglTextureRectangle texture
* or if the size was too large or there wasn't enough memory
* %NULL is returned and @error set.
*
@@ -143,7 +143,7 @@ cogl_texture_rectangle_new_with_size (CoglContext *ctx,
* first check for the %COGL_FEATURE_ID_TEXTURE_RECTANGLE feature
* using cogl_has_feature().</note>
*
- * Returns: A pointer to a newly allocated #CoglRectangle texture
+ * Returns: A pointer to a newly allocated #CoglTextureRectangle texture
* or if the size was too large or there wasn't enough memory
* %NULL is returned and @error set.
* Since: 2.0
diff --git a/doc/reference/cogl2/cogl2-sections.txt b/doc/reference/cogl2/cogl2-sections.txt
index 2316f4f..3593766 100644
--- a/doc/reference/cogl2/cogl2-sections.txt
+++ b/doc/reference/cogl2/cogl2-sections.txt
@@ -1,4 +1,3 @@
-
<SECTION>
<FILE>cogl-object</FILE>
<TITLE>The Object Interface</TITLE>
@@ -6,6 +5,7 @@ CoglObject
cogl_object_ref
cogl_object_unref
CoglUserDataKey
+CoglUserDataDestroyCallback
cogl_object_get_user_data
cogl_object_set_user_data
</SECTION>
@@ -49,6 +49,11 @@ CoglBool
<SECTION>
<FILE>cogl-renderer</FILE>
<TITLE>CoglRenderer: Connect to a backend renderer</TITLE>
+<SUBSECTION>
+CoglRenderer
+cogl_is_renderer
+
+<SUBSECTION>
cogl_renderer_new
cogl_renderer_get_n_fragment_texture_units
cogl_renderer_connect
@@ -59,6 +64,7 @@ cogl_xlib_renderer_get_foreign_display
<SUBSECTION>
CoglXlibFilterFunc
+CoglFilterReturn
cogl_xlib_renderer_add_filter
cogl_xlib_renderer_remove_filter
cogl_xlib_renderer_handle_event
@@ -79,6 +85,11 @@ cogl_wayland_renderer_get_compositor
<SECTION>
<FILE>cogl-swap-chain</FILE>
<TITLE>CoglSwapChain: Describe a set of back buffers for flipping between</TITLE>
+<SUBSECTION>
+CoglSwapChain
+cogl_is_swap_chain
+
+<SUBSECTION>
cogl_swap_chain_new
cogl_swap_chain_set_has_alpha
cogl_swap_chain_set_length
@@ -87,12 +98,22 @@ cogl_swap_chain_set_length
<SECTION>
<FILE>cogl-onscreen-template</FILE>
<TITLE>CoglOnscreenTemplate: Describe a template for onscreen framebuffers</TITLE>
+<SUBSECTION>
+CoglOnscreenTemplate
+cogl_is_onscreen_template
+
+<SUBSECTION>
cogl_onscreen_template_new
</SECTION>
<SECTION>
<FILE>cogl-display</FILE>
<TITLE>CoglDisplay: Setup a display pipeline</TITLE>
+<SUBSECTION>
+CoglDisplay
+cogl_is_display
+
+<SUBSECTION>
cogl_display_new
cogl_display_get_renderer
cogl_display_setup
@@ -109,8 +130,9 @@ cogl_wayland_display_set_compositor_display
<TITLE>The Top-Level Context</TITLE>
<SUBSECTION>
-cogl_context_new
+CoglContext
cogl_is_context
+cogl_context_new
cogl_context_get_display
<SUBSECTION>
@@ -174,6 +196,7 @@ cogl_glib_source_new
<SECTION>
<FILE>cogl-attribute</FILE>
<TITLE>Vertex Attributes</TITLE>
+CoglAttribute
cogl_attribute_new
cogl_is_attribute
cogl_attribute_set_normalized
@@ -191,6 +214,7 @@ CoglIndices
cogl_is_indices
<SUBSECTION>
+CoglIndicesType
cogl_indices_new
</SECTION>
@@ -245,6 +269,7 @@ cogl_snippet_get_post
<SECTION>
<FILE>cogl-paths</FILE>
<TITLE>Path Primitives</TITLE>
+CoglPath
cogl_is_path
cogl_path_new
cogl_path_copy
@@ -384,11 +409,18 @@ cogl_is_texture_2d_sliced
<SECTION>
<FILE>cogl-texture-pixmap-x11</FILE>
<TITLE>X11 Texture From Pixmap</TITLE>
+<SUBSECTION>
+CoglTexturePixmapX11
+cogl_is_texture_pixmap_x11
+
+<SUBSECTION>
cogl_texture_pixmap_x11_new
+
+<SUBSECTION>
cogl_texture_pixmap_x11_update_area
cogl_texture_pixmap_x11_is_using_tfp_extension
+CoglTexturePixmapX11ReportLevel
cogl_texture_pixmap_x11_set_damage_object
-cogl_is_texture_pixmap_x11
</SECTION>
<SECTION>
@@ -480,6 +512,7 @@ COGL_ONSCREEN
cogl_onscreen_new
<SUBSECTION>
+CoglOnscreenX11MaskCallback
cogl_x11_onscreen_set_foreign_window_xid
cogl_x11_onscreen_get_window_xid
cogl_x11_onscreen_get_visual_xid
@@ -496,6 +529,7 @@ cogl_onscreen_hide
cogl_onscreen_swap_buffers
cogl_onscreen_swap_region
cogl_onscreen_set_swap_throttled
+CoglSwapBuffersNotify
cogl_onscreen_add_swap_buffers_callback
cogl_onscreen_remove_swap_buffers_callback
</SECTION>
@@ -503,8 +537,12 @@ cogl_onscreen_remove_swap_buffers_callback
<SECTION>
<FILE>cogl-offscreen</FILE>
<TITLE>Offscreen Framebuffers</TITLE>
-cogl_offscreen_new_to_texture
+<SUBSECTION>
+CoglOffscreen
cogl_is_offscreen
+
+<SUBSECTION>
+cogl_offscreen_new_to_texture
</SECTION>
<SECTION>
@@ -664,6 +702,7 @@ cogl_get_static_zero_quaternion
<SECTION>
<FILE>cogl-pipeline</FILE>
<TITLE>Pipeline</TITLE>
+CoglPipeline
cogl_pipeline_new
cogl_pipeline_copy
cogl_is_pipeline
@@ -714,6 +753,7 @@ cogl_pipeline_get_layer_point_sprite_coords_enabled
cogl_pipeline_remove_layer
cogl_pipeline_get_n_layers
+CoglPipelineLayerCallback
cogl_pipeline_foreach_layer
cogl_pipeline_get_uniform_location
@@ -750,6 +790,7 @@ cogl_depth_state_get_range
<SECTION>
<FILE>cogl-buffer</FILE>
<TITLE>CoglBuffer: The Buffer Interface</TITLE>
+CoglBuffer
cogl_is_buffer
cogl_buffer_get_size
CoglBufferUsageHint
@@ -759,12 +800,14 @@ CoglBufferUpdateHint
cogl_buffer_set_update_hint
cogl_buffer_get_update_hint
CoglBufferAccess
+CoglBufferMapHint
cogl_buffer_map
cogl_buffer_map_range
cogl_buffer_unmap
cogl_buffer_set_data
<SUBSECTION>
+CoglPixelBuffer
cogl_pixel_buffer_new
cogl_is_pixel_buffer
--
1.7.7.5
More information about the Cogl
mailing list