brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Fix the 'Since' annotation for some functions

Browse Source 
The 'Since' annotation needs to have a colon after it or gtk-doc won't
pick it up.
This commit is contained in:
Neil Roberts 2009-11-19 11:51:21 +00:00
parent b4fc8faaab
commit 8f21013ee6
3 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
cogl/cogl-material.h
View File

@ -106,7 +106,7 @@ CoglHandle cogl_material_new (void);
* *
* Returns: the @handle. * Returns: the @handle.
* *
* Since 1.0 * Since: 1.0
*/ */
CoglHandle cogl_material_ref (CoglHandle handle); CoglHandle cogl_material_ref (CoglHandle handle);
@ -116,7 +116,7 @@ CoglHandle cogl_material_ref (CoglHandle handle);
* *
* Decrement the reference count for a cogl material. * Decrement the reference count for a cogl material.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_unref (CoglHandle handle); void cogl_material_unref (CoglHandle handle);
@ -145,7 +145,7 @@ gboolean cogl_is_material (CoglHandle handle);
* *
* The default value is (1.0, 1.0, 1.0, 1.0) * The default value is (1.0, 1.0, 1.0, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_color (CoglHandle material, void cogl_material_set_color (CoglHandle material,
const CoglColor *color); const CoglColor *color);
@ -162,7 +162,7 @@ void cogl_material_set_color (CoglHandle material,
* *
* The default value is (0xff, 0xff, 0xff, 0xff) * The default value is (0xff, 0xff, 0xff, 0xff)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_color4ub (CoglHandle material, void cogl_material_set_color4ub (CoglHandle material,
guint8 red, guint8 red,
@ -182,7 +182,7 @@ void cogl_material_set_color4ub (CoglHandle material,
* *
* The default value is (1.0, 1.0, 1.0, 1.0) * The default value is (1.0, 1.0, 1.0, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_color4f (CoglHandle material, void cogl_material_set_color4f (CoglHandle material,
float red, float red,
@ -197,7 +197,7 @@ void cogl_material_set_color4f (CoglHandle material,
* *
* This retrieves the current material color. * This retrieves the current material color.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_get_color (CoglHandle material, void cogl_material_get_color (CoglHandle material,
CoglColor *color); CoglColor *color);
@ -215,7 +215,7 @@ void cogl_material_get_color (CoglHandle material,
* *
* The default value is (0.2, 0.2, 0.2, 1.0) * The default value is (0.2, 0.2, 0.2, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_ambient (CoglHandle material, void cogl_material_set_ambient (CoglHandle material,
const CoglColor *ambient); const CoglColor *ambient);
@ -227,7 +227,7 @@ void cogl_material_set_ambient (CoglHandle material,
* *
* This retrieves the materials current ambient color. * This retrieves the materials current ambient color.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_get_ambient (CoglHandle material, void cogl_material_get_ambient (CoglHandle material,
CoglColor *ambient); CoglColor *ambient);
@ -244,7 +244,7 @@ void cogl_material_get_ambient (CoglHandle material,
* *
* The default value is (0.8, 0.8, 0.8, 1.0) * The default value is (0.8, 0.8, 0.8, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_diffuse (CoglHandle material, void cogl_material_set_diffuse (CoglHandle material,
const CoglColor *diffuse); const CoglColor *diffuse);
@ -256,7 +256,7 @@ void cogl_material_set_diffuse (CoglHandle material,
* *
* This retrieves the materials current diffuse color. * This retrieves the materials current diffuse color.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_get_diffuse (CoglHandle material, void cogl_material_get_diffuse (CoglHandle material,
CoglColor *diffuse); CoglColor *diffuse);
@ -272,7 +272,7 @@ void cogl_material_get_diffuse (CoglHandle material,
* The default ambient color is (0.2, 0.2, 0.2, 1.0) * The default ambient color is (0.2, 0.2, 0.2, 1.0)
* The default diffuse color is (0.8, 0.8, 0.8, 1.0) * The default diffuse color is (0.8, 0.8, 0.8, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_ambient_and_diffuse (CoglHandle material, void cogl_material_set_ambient_and_diffuse (CoglHandle material,
const CoglColor *color); const CoglColor *color);
@ -289,7 +289,7 @@ void cogl_material_set_ambient_and_diffuse (CoglHandle material,
* *
* The default value is (0.0, 0.0, 0.0, 1.0) * The default value is (0.0, 0.0, 0.0, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_specular (CoglHandle material, void cogl_material_set_specular (CoglHandle material,
const CoglColor *specular); const CoglColor *specular);
@ -301,7 +301,7 @@ void cogl_material_set_specular (CoglHandle material,
* *
* This retrieves the materials current specular color. * This retrieves the materials current specular color.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_get_specular (CoglHandle material, void cogl_material_get_specular (CoglHandle material,
CoglColor *specular); CoglColor *specular);
@ -317,7 +317,7 @@ void cogl_material_get_specular (CoglHandle material,
* *
* The default value is 0.0 * The default value is 0.0
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_shininess (CoglHandle material, void cogl_material_set_shininess (CoglHandle material,
float shininess); float shininess);
@ -329,7 +329,7 @@ void cogl_material_set_shininess (CoglHandle material,
* *
* Return value: The materials current shininess value * Return value: The materials current shininess value
* *
* Since 1.0 * Since: 1.0
*/ */
float cogl_material_get_shininess (CoglHandle material); float cogl_material_get_shininess (CoglHandle material);
@ -344,7 +344,7 @@ float cogl_material_get_shininess (CoglHandle material);
* *
* The default value is (0.0, 0.0, 0.0, 1.0) * The default value is (0.0, 0.0, 0.0, 1.0)
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_emission (CoglHandle material, void cogl_material_set_emission (CoglHandle material,
const CoglColor *emission); const CoglColor *emission);
@ -356,7 +356,7 @@ void cogl_material_set_emission (CoglHandle material,
* *
* This retrieves the materials current emission color. * This retrieves the materials current emission color.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_get_emission (CoglHandle material, void cogl_material_get_emission (CoglHandle material,
CoglColor *emission); CoglColor *emission);
@ -416,7 +416,7 @@ typedef enum _CoglMaterialAlphaFunc
* *
* The default is COGL_MATERIAL_ALPHA_FUNC_ALWAYS * The default is COGL_MATERIAL_ALPHA_FUNC_ALWAYS
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_alpha_test_function (CoglHandle material, void cogl_material_set_alpha_test_function (CoglHandle material,
CoglMaterialAlphaFunc alpha_func, CoglMaterialAlphaFunc alpha_func,
@ -531,7 +531,7 @@ void cogl_material_set_blend_constant (CoglHandle material,
* <note>In the future, we may define other types of material layers, such * <note>In the future, we may define other types of material layers, such
* as purely GLSL based layers.</note> * as purely GLSL based layers.</note>
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_layer (CoglHandle material, void cogl_material_set_layer (CoglHandle material,
int layer_index, int layer_index,
@ -651,7 +651,7 @@ cogl_material_set_layer_combine (CoglHandle material,
* When you are using the 'CONSTANT' color source in a layer combine * When you are using the 'CONSTANT' color source in a layer combine
* description then you can use this function to define its value. * description then you can use this function to define its value.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_material_set_layer_combine_constant (CoglHandle material, void cogl_material_set_layer_combine_constant (CoglHandle material,
int layer_index, int layer_index,

6
cogl/cogl-texture.h
View File

@ -347,7 +347,7 @@ void cogl_texture_unref (CoglHandle handle);
* to be used for the first texture layer of the material. To draw the entire * to be used for the first texture layer of the material. To draw the entire
* texture pass in @tx1=0.0 @ty1=0.0 @tx2=1.0 @ty2=1.0. * texture pass in @tx1=0.0 @ty1=0.0 @tx2=1.0 @ty2=1.0.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_rectangle_with_texture_coords (float x1, void cogl_rectangle_with_texture_coords (float x1,
float y1, float y1,
@ -383,7 +383,7 @@ void cogl_rectangle_with_texture_coords (float x1,
* layers in the current source material then default texture coordinates * layers in the current source material then default texture coordinates
* (0.0, 0.0, 1.0, 1.0) are generated. * (0.0, 0.0, 1.0, 1.0) are generated.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_rectangle_with_multitexture_coords (float x1, void cogl_rectangle_with_multitexture_coords (float x1,
float y1, float y1,
@ -454,7 +454,7 @@ void cogl_rectangles (const float *verts,
* if either the texture is not sliced or the backend is not OpenGL ES and the * if either the texture is not sliced or the backend is not OpenGL ES and the
* minifying and magnifying functions are both set to CGL_NEAREST. * minifying and magnifying functions are both set to CGL_NEAREST.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_polygon (CoglTextureVertex *vertices, void cogl_polygon (CoglTextureVertex *vertices,
guint n_vertices, guint n_vertices,

4
cogl/cogl.h
View File

@ -477,7 +477,7 @@ void cogl_clear (const CoglColor *color,
* and a back facing material, in which case this function will set both to the * and a back facing material, in which case this function will set both to the
* same. * same.
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_set_source (CoglHandle material); void cogl_set_source (CoglHandle material);
@ -561,7 +561,7 @@ void cogl_set_source_color4f (float red,
* cogl_set_source (material); * cogl_set_source (material);
* </programlisting> * </programlisting>
* *
* Since 1.0 * Since: 1.0
*/ */
void cogl_set_source_texture (CoglHandle texture_handle); void cogl_set_source_texture (CoglHandle texture_handle);