[totem] Add missing documentation
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [totem] Add missing documentation
- Date: Sat, 19 Jun 2010 18:30:22 +0000 (UTC)
commit 02e0d2b0b177e4da1e2eb26bc829e23dd3280148
Author: Philip Withnall <philip tecnocode co uk>
Date: Sat Jun 19 19:07:55 2010 +0100
Add missing documentation
docs/reference/totem-sections.txt | 2 +-
src/plugins/totem-dirs.c | 9 +++++++++
src/plugins/totem-plugin.h | 9 +++++++++
src/totem-object.c | 3 ++-
4 files changed, 21 insertions(+), 2 deletions(-)
---
diff --git a/docs/reference/totem-sections.txt b/docs/reference/totem-sections.txt
index 3912860..89e47a5 100644
--- a/docs/reference/totem-sections.txt
+++ b/docs/reference/totem-sections.txt
@@ -105,6 +105,7 @@ totem_interface_set_transient_for
TOTEM_PLUGIN_REGISTER
totem_plugin_find_file
totem_plugin_load_interface
+totem_get_plugin_paths
</SECTION>
<SECTION>
@@ -166,7 +167,6 @@ bacon_video_widget_seek
bacon_video_widget_seek_time
bacon_video_widget_stop
bacon_video_widget_close
-bacon_video_widget_can_deinterlace
bacon_video_widget_can_direct_seek
bacon_video_widget_can_get_frames
bacon_video_widget_can_set_volume
diff --git a/src/plugins/totem-dirs.c b/src/plugins/totem-dirs.c
index 4209096..51080ea 100644
--- a/src/plugins/totem-dirs.c
+++ b/src/plugins/totem-dirs.c
@@ -49,6 +49,15 @@
#define UNINSTALLED_PLUGINS_LOCATION "plugins"
+/**
+ * totem_get_plugin_paths:
+ *
+ * Return a %NULL-terminated array of paths to directories which can contain Totem plugins. This respects the GConf disable_user_plugins setting.
+ *
+ * Return value: a %NULL-terminated array of paths to plugin directories
+ *
+ * Since: 2.90.0
+ **/
char **
totem_get_plugin_paths (void)
{
diff --git a/src/plugins/totem-plugin.h b/src/plugins/totem-plugin.h
index d71be3d..a545026 100644
--- a/src/plugins/totem-plugin.h
+++ b/src/plugins/totem-plugin.h
@@ -36,6 +36,15 @@
G_BEGIN_DECLS
+/**
+ * TOTEM_PLUGIN_REGISTER:
+ * @TYPE_NAME: the name of the plugin type, in UPPER_CASE
+ * @TypeName: the name of the plugin type, in CamelCase
+ * @type_name: the name of the plugin type, in lower_case
+ *
+ * Registers a plugin with the Totem plugin system, including registering the type specified in the parameters and declaring its activate and
+ * deactivate functions.
+ **/
#define TOTEM_PLUGIN_REGISTER(TYPE_NAME, TypeName, type_name) \
static void impl_activate (PeasActivatable *plugin, GObject *totem); \
static void impl_deactivate (PeasActivatable *plugin, GObject *totem); \
diff --git a/src/totem-object.c b/src/totem-object.c
index 5ea1044..6955244 100644
--- a/src/totem-object.c
+++ b/src/totem-object.c
@@ -339,6 +339,7 @@ totem_object_plugins_init (TotemObject *totem)
/**
* totem_object_plugins_shutdown:
+ * @totem: a #TotemObject
*
* Shuts down the plugin engine and deactivates all the
* plugins.
@@ -2026,7 +2027,7 @@ totem_action_zoom_reset (Totem *totem)
}
/**
- * totem_action_get_volume:
+ * totem_get_volume:
* @totem: a #TotemObject
*
* Gets the current volume level, as a value between %0.0 and %1.0.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]