doc: Some fixes for the Cogl documentation

• 3 general fixes (typos, copy/paste),
 • ignore cogl-object-private.h,
 • cogl_fixed_atani() was in reality cogl_fixed_atan(), fixed in commit
   43564f05.
 • Fix the cogl-vector section: sections must have a </SECTION> tag at
   the end. Also the cogl-vector section was added in the middle of the
   cogl-buffer one. Let's shiffle it out and add that </SECTION> tag.
This commit is contained in:
Damien Lespiau 2010-06-05 21:05:23 +01:00
parent 7fa011b037
commit 2e52c5f67b
3 changed files with 11 additions and 9 deletions

View File

@ -81,10 +81,10 @@ cogl_handle_ref (CoglHandle handle);
* count reaches 0, the resources allocated by @handle will be freed * count reaches 0, the resources allocated by @handle will be freed
*/ */
void void
cogl_handle_unref (CoglHandle Handle); cogl_handle_unref (CoglHandle handle);
/** /**
* cogl_handle_ref: * cogl_object_ref:
* @object: a #CoglObject * @object: a #CoglObject
* *
* Increases the reference count of @handle by 1 * Increases the reference count of @handle by 1
@ -95,7 +95,7 @@ void *
cogl_object_ref (void *object); cogl_object_ref (void *object);
/** /**
* cogl_handle_unref: * cogl_object_unref:
* @object: a #CoglObject * @object: a #CoglObject
* *
* Drecreases the reference count of @object by 1; if the reference * Drecreases the reference count of @object by 1; if the reference

View File

@ -74,6 +74,7 @@ IGNORE_HFILES=\
cogl-matrix-private.h \ cogl-matrix-private.h \
cogl-matrix-stack.h \ cogl-matrix-stack.h \
cogl-spans.h \ cogl-spans.h \
cogl-object-private.h \
cogl-pixel-buffer-private.h \ cogl-pixel-buffer-private.h \
cogl-profile.h \ cogl-profile.h \
cogl-sub-texture-private.h \ cogl-sub-texture-private.h \

View File

@ -329,7 +329,7 @@ cogl_sqrti
<SUBSECTION> <SUBSECTION>
cogl_fixed_atan2 cogl_fixed_atan2
cogl_fixed_atani cogl_fixed_atan
cogl_fixed_cos cogl_fixed_cos
cogl_fixed_log2 cogl_fixed_log2
cogl_fixed_pow cogl_fixed_pow
@ -508,6 +508,12 @@ cogl_is_pixel_buffer
<SUBSECTION> <SUBSECTION>
cogl_texture_new_from_buffer cogl_texture_new_from_buffer
<SUBSECTION Private>
cogl_buffer_access_get_type
cogl_buffer_update_hint_get_type
cogl_buffer_usage_hint_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>cogl-vector</FILE> <FILE>cogl-vector</FILE>
<TITLE>Vectors</TITLE> <TITLE>Vectors</TITLE>
@ -527,9 +533,4 @@ cogl_vector3_magnitude
cogl_vector3_cross_product cogl_vector3_cross_product
cogl_vector3_dot_product cogl_vector3_dot_product
cogl_vector3_distance cogl_vector3_distance
<SUBSECTION Private>
cogl_buffer_access_get_type
cogl_buffer_update_hint_get_type
cogl_buffer_usage_hint_get_type
</SECTION> </SECTION>