[totem/gnome-2-28] Fix documentation checks failing

[Bastien Nocera <hadess src gnome org>]

commit 44068ed3e463c519885d561a3941fb049f613bf7
Author: Bastien Nocera <hadess hadess net>
Date:   Fri Dec 11 15:39:11 2009 +0000

    Fix documentation checks failing

 docs/reference/Makefile.am                |    6 +++++-
 docs/reference/totem-sections.txt         |    9 +++++----
 src/backend/bacon-video-widget-gst-0.10.c |   28 +++++++++++++++++++++++-----
 src/backend/bacon-video-widget.h          |    6 ++----
 src/totem-object.c                        |    2 +-
 5 files changed, 36 insertions(+), 15 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index ac42879..8f06155 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -54,11 +54,15 @@ IGNORE_HFILES = \
 	ev-sidebar.h			\
 	eggdesktopfile.h		\
 	eggfileformatchooser.h		\
+	egg-macros.h			\
 	eggsmclient.h			\
 	eggsmclient-private.h		\
+	gnome-screenshot-widget.h	\
 	totemobject-marshal.h		\
 	totemplaylist-marshal.h		\
-	totemvideolist-marshal.h
+	totemvideolist-marshal.h	\
+	totem-profile.h			\
+	totem-sample-vala-plugin.h
 
 # Files we don't want exported to plugins
 IGNORE_HFILES += \
diff --git a/docs/reference/totem-sections.txt b/docs/reference/totem-sections.txt
index dc2d573..617db66 100644
--- a/docs/reference/totem-sections.txt
+++ b/docs/reference/totem-sections.txt
@@ -52,8 +52,8 @@ totem_get_current_time
 totem_set_current_subtitle
 totem_get_playlist_length
 totem_get_playlist_pos
-totem_get_short_title
 totem_get_title_at_playlist_pos
+totem_get_short_title
 totem_add_sidebar_page
 totem_remove_sidebar_page
 <SUBSECTION Standard>
@@ -83,8 +83,6 @@ totem_action_set_mrl_with_warning
 totem_interface_error
 totem_interface_error_blocking
 totem_interface_error_with_link
-totem_interface_boldify_label
-totem_interface_italicise_label
 <SUBSECTION Private>
 totem_interface_get_full_path
 totem_interface_get_license
@@ -197,6 +195,7 @@ bacon_video_widget_can_direct_seek
 bacon_video_widget_can_get_frames
 bacon_video_widget_can_set_volume
 bacon_video_widget_dvd_event
+bacon_video_widget_has_menus
 bacon_video_widget_get_aspect_ratio
 bacon_video_widget_set_aspect_ratio
 bacon_video_widget_get_audio_out_type
@@ -217,11 +216,11 @@ bacon_video_widget_set_language
 bacon_video_widget_set_logo
 bacon_video_widget_get_logo_mode
 bacon_video_widget_set_logo_mode
-bacon_video_widget_set_logo_pixbuf
 bacon_video_widget_get_metadata
 bacon_video_widget_get_mrls
 bacon_video_widget_get_option_group
 bacon_video_widget_get_position
+bacon_video_widget_set_referrer
 bacon_video_widget_set_scale_ratio
 bacon_video_widget_get_show_cursor
 bacon_video_widget_set_show_cursor
@@ -232,6 +231,7 @@ bacon_video_widget_get_subtitle
 bacon_video_widget_set_subtitle
 bacon_video_widget_set_subtitle_encoding
 bacon_video_widget_set_subtitle_font
+bacon_video_widget_set_user_agent
 bacon_video_widget_get_video_property
 bacon_video_widget_set_video_property
 bacon_video_widget_get_visuals_list
@@ -245,6 +245,7 @@ bacon_video_widget_has_next_track
 bacon_video_widget_has_previous_track
 bacon_video_widget_is_playing
 bacon_video_widget_is_seekable
+bacon_video_widget_step
 <SUBSECTION Standard>
 bacon_video_widget_error_quark
 bacon_video_widget_get_type
diff --git a/src/backend/bacon-video-widget-gst-0.10.c b/src/backend/bacon-video-widget-gst-0.10.c
index efcf02e..efceb53 100644
--- a/src/backend/bacon-video-widget-gst-0.10.c
+++ b/src/backend/bacon-video-widget-gst-0.10.c
@@ -3472,15 +3472,15 @@ bacon_video_widget_can_direct_seek (BaconVideoWidget *bvw)
  * Return value: %TRUE on success, %FALSE otherwise
  **/
 gboolean
-bacon_video_widget_seek_time (BaconVideoWidget *bvw, gint64 _time, GError **error)
+bacon_video_widget_seek_time (BaconVideoWidget *bvw, gint64 time, GError **error)
 {
   g_return_val_if_fail (bvw != NULL, FALSE);
   g_return_val_if_fail (BACON_IS_VIDEO_WIDGET (bvw), FALSE);
   g_return_val_if_fail (GST_IS_ELEMENT (bvw->priv->play), FALSE);
 
-  GST_LOG ("Seeking to %" GST_TIME_FORMAT, GST_TIME_ARGS (_time * GST_MSECOND));
+  GST_LOG ("Seeking to %" GST_TIME_FORMAT, GST_TIME_ARGS (time * GST_MSECOND));
 
-  if (_time > bvw->priv->stream_length
+  if (time > bvw->priv->stream_length
       && bvw->priv->stream_length > 0
       && !g_str_has_prefix (bvw->priv->mrl, "dvd:")
       && !g_str_has_prefix (bvw->priv->mrl, "vcd:")) {
@@ -3490,11 +3490,11 @@ bacon_video_widget_seek_time (BaconVideoWidget *bvw, gint64 _time, GError **erro
   }
 
   /* Emit a time tick of where we are going, we are paused */
-  got_time_tick (bvw->priv->play, _time * GST_MSECOND, bvw);
+  got_time_tick (bvw->priv->play, time * GST_MSECOND, bvw);
   
   gst_element_seek (bvw->priv->play, 1.0,
       GST_FORMAT_TIME, GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT,
-      GST_SEEK_TYPE_SET, _time * GST_MSECOND,
+      GST_SEEK_TYPE_SET, time * GST_MSECOND,
       GST_SEEK_TYPE_NONE, GST_CLOCK_TIME_NONE);
 
   gst_element_get_state (bvw->priv->play, NULL, NULL, 100 * GST_MSECOND);
@@ -3531,6 +3531,15 @@ bacon_video_widget_seek (BaconVideoWidget *bvw, double position, GError **error)
   return bacon_video_widget_seek_time (bvw, seek_time / GST_MSECOND, error);
 }
 
+/**
+ * bacon_video_widget_step:
+ * @bvw: a #BaconVideoWidget
+ * @error: a #GError, or %NULL
+ *
+ * Step one frame forward.
+ *
+ * Return value: %TRUE on success, %FALSE otherwise
+ **/
 gboolean
 bacon_video_widget_step (BaconVideoWidget *bvw, GError **error)
 {
@@ -4819,6 +4828,15 @@ done:
   return ret;
 }
 
+/**
+ * bacon_video_widget_has_menus:
+ * @bvw: a #BaconVideoWidget
+ *
+ * Returns whether the widget is currently displaying a menu,
+ * such as a DVD menu.
+ *
+ * Return value: %TRUE if a menu is displyed, %FALSE otherwise
+ **/
 gboolean
 bacon_video_widget_has_menus (BaconVideoWidget *bvw)
 {
diff --git a/src/backend/bacon-video-widget.h b/src/backend/bacon-video-widget.h
index 6e516b5..35206c8 100644
--- a/src/backend/bacon-video-widget.h
+++ b/src/backend/bacon-video-widget.h
@@ -181,7 +181,7 @@ gboolean bacon_video_widget_seek		 (BaconVideoWidget *bvw,
 						  double position,
 						  GError **error);
 gboolean bacon_video_widget_seek_time		 (BaconVideoWidget *bvw,
-						  gint64 _time,
+						  gint64 time,
 						  GError **error);
 gboolean bacon_video_widget_step		 (BaconVideoWidget *bvw,
 						  GError **error);
@@ -201,9 +201,7 @@ double bacon_video_widget_get_volume             (BaconVideoWidget *bvw);
 
 /* Properties */
 void bacon_video_widget_set_logo		 (BaconVideoWidget *bvw,
-						  const char *filename);
-void bacon_video_widget_set_logo_pixbuf		 (BaconVideoWidget *bvw,
-						  GdkPixbuf *logo);
+						  const char *name);
 void  bacon_video_widget_set_logo_mode		 (BaconVideoWidget *bvw,
 						  gboolean logo_mode);
 gboolean bacon_video_widget_get_logo_mode	 (BaconVideoWidget *bvw);
diff --git a/src/totem-object.c b/src/totem-object.c
index 170af10..165a437 100644
--- a/src/totem-object.c
+++ b/src/totem-object.c
@@ -527,7 +527,7 @@ totem_get_playlist_pos (Totem *totem)
 /**
  * totem_get_title_at_playlist_pos:
  * @totem: a #TotemObject
- * @index: the %0-based entry index
+ * @playlist_index: the %0-based entry index
  *
  * Gets the title of the playlist entry at @index.
  *