sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

Fix some documentation problems

Browse source 
• The documentation for the framebuffer and texture interfaces had a
  mis-matching open and close <note> tag so DocBook got upset and the
  whole documentation disappeared.

• A lot of symbols from the cogl_framebuffer_* interface were missing
  from the cogl-2.0-experimental-sections.txt file.

• cogl_framebuffer_frustum had the wrong version in its Since tag:

Reviewed-by: Robert Bragg <robert@linux.intel.com>
This commit is contained in:
Neil Roberts 2012-03-20 13:17:07 +00:00
parent f485fa6b21
commit 59cc2b7071
3 changed files with 34 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
cogl/cogl-framebuffer.h
View file

@ -467,7 +467,7 @@ cogl_framebuffer_frustum (CoglFramebuffer *framebuffer,
* Replaces the current projection matrix with an orthographic projection
* matrix.
*
* Since: 1.0
* Since: 1.10
* Stability: unstable
*/
void
@ -1241,7 +1241,7 @@ cogl_framebuffer_draw_indexed_attributes (CoglFramebuffer *framebuffer,
*
* <note>If you want to describe a rectangle with a texture mapped on
* it then you can use
* cogl_framebuffer_draw_textured_rectangle().<note>
* cogl_framebuffer_draw_textured_rectangle().</note>
*
* Since: 1.10
* Stability: unstable

2
cogl/cogl-texture.h
View file

@ -293,7 +293,7 @@ cogl_texture_get_format (CoglTexture *texture);
* internally since underlying drivers are free to use a different
* format</note>
*
* </note>This API is only here for backwards compatibility and
* <note>This API is only here for backwards compatibility and
* shouldn't be used in new code. In particular please don't be
* mislead to pass the returned value to cogl_texture_get_data() for
* the rowstride, since you should be passing the rowstride you desire

31
doc/reference/cogl-2.0-experimental/cogl-2.0-experimental-sections.txt
View file

@ -384,6 +384,7 @@ cogl_framebuffer_get_viewport_y
cogl_framebuffer_get_viewport_width
cogl_framebuffer_get_viewport_height
cogl_framebuffer_get_viewport4fv
cogl_framebuffer_get_color_format
cogl_framebuffer_get_red_bits
cogl_framebuffer_get_green_bits
cogl_framebuffer_get_blue_bits
@ -392,16 +393,22 @@ cogl_framebuffer_get_color_mask
cogl_framebuffer_set_color_mask
cogl_framebuffer_get_point_samples_per_pixel
cogl_framebuffer_set_point_samples_per_pixel
cogl_framebuffer_resolve_samples
cogl_framebuffer_resolve_samples_region
cogl_framebuffer_get_context
cogl_framebuffer_clear
cogl_framebuffer_clear4f
cogl_framebuffer_read_pixels_into_bitmap
cogl_framebuffer_read_pixels
cogl_framebuffer_set_dither_enabled
cogl_framebuffer_get_dither_enabled
<SUBSECTION>
cogl_framebuffer_draw_primitive
cogl_framebuffer_draw_attributes
cogl_framebuffer_vdraw_attributes
cogl_framebuffer_draw_indexed_attributes
cogl_framebuffer_vdraw_indexed_attributes
cogl_framebuffer_draw_rectangle
cogl_framebuffer_draw_textured_rectangle
cogl_framebuffer_draw_multitextured_rectangle
@ -415,6 +422,30 @@ cogl_framebuffer_add_swap_buffers_callback
cogl_framebuffer_remove_swap_buffers_callback
cogl_framebuffer_finish
<SUBSECTION>
cogl_framebuffer_push_matrix
cogl_framebuffer_pop_matrix
cogl_framebuffer_identity_matrix
cogl_framebuffer_scale
cogl_framebuffer_translate
cogl_framebuffer_rotate
cogl_framebuffer_transform
cogl_framebuffer_get_modelview_matrix
cogl_framebuffer_set_modelview_matrix
<SUBSECTION>
cogl_framebuffer_perspective
cogl_framebuffer_frustum
cogl_framebuffer_orthographic
cogl_framebuffer_get_projection_matrix
cogl_framebuffer_set_projection_matrix
<SUBSECTION>
cogl_framebuffer_push_scissor_clip
cogl_framebuffer_push_rectangle_clip
cogl_framebuffer_push_primitive_clip
cogl_framebuffer_pop_clip
<SUBSECTION>
cogl_get_draw_framebuffer
cogl_set_framebuffer