2006-06-22 Ross Burton <ross@openedhand.com>

* clutter/clutter-label.c:
	* clutter/clutter-video-texture.c:
	* clutter/clutter-texture.c:
	* clutter/clutter-timeline.c:
	Fix gtk-doc problems.
This commit is contained in:
Ross Burton 2006-06-22 09:14:35 +00:00
parent ad77326868
commit 58f2fff6d7
5 changed files with 35 additions and 27 deletions

View File

@ -1,3 +1,11 @@
2006-06-22 Ross Burton <ross@openedhand.com>
* clutter/clutter-label.c:
* clutter/clutter-video-texture.c:
* clutter/clutter-texture.c:
* clutter/clutter-timeline.c:
Fix gtk-doc problems.
2006-06-22 Iain Holmes <iain@openedhand.com> 2006-06-22 Iain Holmes <iain@openedhand.com>
* clutter/clutter-main.c: More documentation * clutter/clutter-main.c: More documentation

View File

@ -527,7 +527,7 @@ clutter_label_set_text_extents (ClutterLabel *label,
* @width: return location for the width of the extents or %NULL * @width: return location for the width of the extents or %NULL
* @height: return location for the height of the extents or %NULL * @height: return location for the height of the extents or %NULL
* *
* Returns the extents of the label. * Gets the extents of the label.
*/ */
void void
clutter_label_get_text_extents (ClutterLabel *label, clutter_label_get_text_extents (ClutterLabel *label,

View File

@ -904,10 +904,10 @@ clutter_texture_init (ClutterTexture *self)
} }
/** /**
* clutter_texture_get_pixbuf * clutter_texture_get_pixbuf:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* *
* Gets the underlying #GdkPixbuf for the #ClutterTexture * Gets the underlying #GdkPixbuf for the #ClutterTexture.
* *
* Return value: The underlying #GdkPixbuf * Return value: The underlying #GdkPixbuf
**/ **/
@ -918,8 +918,8 @@ clutter_texture_get_pixbuf (ClutterTexture* texture)
} }
/** /**
* clutter_texture_set_pixbuf * clutter_texture_set_pixbuf:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* @pixbuf: A #GdkPixbuf * @pixbuf: A #GdkPixbuf
* *
* Sets the underlying #GdkPixbuf for the #ClutterTexture * Sets the underlying #GdkPixbuf for the #ClutterTexture
@ -1017,7 +1017,7 @@ clutter_texture_set_pixbuf (ClutterTexture *texture, GdkPixbuf *pixbuf)
} }
/** /**
* clutter_texture_new_from_pixbuf * clutter_texture_new_from_pixbuf:
* @pixbuf: A #GdkPixbuf * @pixbuf: A #GdkPixbuf
* *
* Creates a new #ClutterTexture object. * Creates a new #ClutterTexture object.
@ -1035,7 +1035,7 @@ clutter_texture_new_from_pixbuf (GdkPixbuf *pixbuf)
} }
/** /**
* clutter_texture_new * clutter_texture_new:
* *
* Creates a new empty #ClutterTexture object. * Creates a new empty #ClutterTexture object.
* *
@ -1052,7 +1052,7 @@ clutter_texture_new (void)
} }
/** /**
* clutter_texture_get_base_size * clutter_texture_get_base_size:
* @texture: A #ClutterTexture * @texture: A #ClutterTexture
* @width: Pointer to gint to be populated with width value if non NULL. * @width: Pointer to gint to be populated with width value if non NULL.
* @height: Pointer to gint to be populated with height value if non NULL. * @height: Pointer to gint to be populated with height value if non NULL.
@ -1081,8 +1081,8 @@ clutter_texture_get_base_size (ClutterTexture *texture,
} }
/** /**
* clutter_texture_bind_tile * clutter_texture_bind_tile:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* @index: Tile index to bind * @index: Tile index to bind
* *
* Proxys a call to glBindTexture a to bind an internal 'tile'. * Proxys a call to glBindTexture a to bind an internal 'tile'.
@ -1100,8 +1100,8 @@ clutter_texture_bind_tile (ClutterTexture *texture, gint index)
} }
/** /**
* clutter_texture_get_n_tiles * clutter_texture_get_n_tiles:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* @n_x_tiles: Location to store number of tiles in horizonally axis * @n_x_tiles: Location to store number of tiles in horizonally axis
* @n_y_tiles: Location to store number of tiles in vertical axis * @n_y_tiles: Location to store number of tiles in vertical axis
* *
@ -1124,8 +1124,8 @@ clutter_texture_get_n_tiles (ClutterTexture *texture,
} }
/** /**
* clutter_texture_get_x_tile_detail * clutter_texture_get_x_tile_detail:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* @x_index: X index of tile to query * @x_index: X index of tile to query
* @pos: Location to store tiles X position * @pos: Location to store tiles X position
* @size: Location to store tiles horizontal size in pixels * @size: Location to store tiles horizontal size in pixels
@ -1156,9 +1156,9 @@ clutter_texture_get_x_tile_detail (ClutterTexture *texture,
} }
/** /**
* clutter_texture_get_y_tile_detail * clutter_texture_get_y_tile_detail:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* @x_index: Y index of tile to query * @y_index: Y index of tile to query
* @pos: Location to store tiles Y position * @pos: Location to store tiles Y position
* @size: Location to store tiles vertical size in pixels * @size: Location to store tiles vertical size in pixels
* @waste: Location to store tiles vertical wastage in pixels * @waste: Location to store tiles vertical wastage in pixels
@ -1188,8 +1188,8 @@ clutter_texture_get_y_tile_detail (ClutterTexture *texture,
} }
/** /**
* clutter_texture_has_generated_tiles * clutter_texture_has_generated_tiles:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* *
* Checks if #ClutterTexture has generated underlying GL texture tiles. * Checks if #ClutterTexture has generated underlying GL texture tiles.
* *
@ -1205,8 +1205,8 @@ clutter_texture_has_generated_tiles (ClutterTexture *texture)
} }
/** /**
* clutter_texture_has_generated_tiles * clutter_texture_has_generated_tiles:
* @texture A #ClutterTexture * @texture: A #ClutterTexture
* *
* Checks if #ClutterTexture is tiled. * Checks if #ClutterTexture is tiled.
* *

View File

@ -445,7 +445,7 @@ clutter_timeline_get_n_frames (ClutterTimeline *timeline)
} }
/** /**
* clutter_timeline_get_current_frame: * clutter_timeline_set_speed:
* @timeline: A #ClutterTimeline * @timeline: A #ClutterTimeline
* @fps: New speed of timeline as frames per second * @fps: New speed of timeline as frames per second
* *

View File

@ -152,10 +152,10 @@ set_uri (ClutterMedia *media,
if (uri) if (uri)
gst_element_set_state (priv->playbin, state); gst_element_set_state (priv->playbin, state);
/** /*
* Emit notififications for all these to make sure UI is not showing * Emit notififications for all these to make sure UI is not showing
* any properties of the old URI. * any properties of the old URI.
**/ */
g_object_notify (G_OBJECT (video_texture), "uri"); g_object_notify (G_OBJECT (video_texture), "uri");
g_object_notify (G_OBJECT (video_texture), "can-seek"); g_object_notify (G_OBJECT (video_texture), "can-seek");
g_object_notify (G_OBJECT (video_texture), "duration"); g_object_notify (G_OBJECT (video_texture), "duration");
@ -648,10 +648,10 @@ bus_message_state_change_cb (GstBus *bus,
NULL, NULL,
NULL); NULL);
} else { } else {
/** /*
* Could not query for ability to seek. Determine * Could not query for ability to seek. Determine
* using URI. * using URI.
**/ */
if (g_str_has_prefix (video_texture->priv->uri, if (g_str_has_prefix (video_texture->priv->uri,
"http://")) { "http://")) {