[farsight2/master] Little documentation fixes

Olivier Crête olivier.crete at collabora.co.uk
Tue Dec 23 15:19:34 PST 2008


---
 gst-libs/gst/farsight/fs-plugin.c |    1 +
 gst-libs/gst/farsight/fs-plugin.h |    6 +++---
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/gst-libs/gst/farsight/fs-plugin.c b/gst-libs/gst/farsight/fs-plugin.c
index 1eae591..fd92149 100644
--- a/gst-libs/gst/farsight/fs-plugin.c
+++ b/gst-libs/gst/farsight/fs-plugin.c
@@ -286,6 +286,7 @@ fs_plugin_get_by_name (const gchar * name, const gchar * type_suffix)
  * fs_plugin_create_valist:
  * @name: The name of the plugin to load
  * @type_suffix: The type of plugin to load (normally "transmitter")
+ * @error: location of a #GError, or NULL if no error occured
  * @first_property_name: The name of the first property to be set on the
  *   object
  * @var_args: The rest of the arguments
diff --git a/gst-libs/gst/farsight/fs-plugin.h b/gst-libs/gst/farsight/fs-plugin.h
index 28abd63..73f1b47 100644
--- a/gst-libs/gst/farsight/fs-plugin.h
+++ b/gst-libs/gst/farsight/fs-plugin.h
@@ -92,9 +92,9 @@ GObject *fs_plugin_create_valist (const gchar *name,
 
 /**
  * FS_INIT_PLUGIN:
- * @type: The #GType that this plugin provides
- * @unload: a function of type void (*unload) (FsPlugin * plugin) to be called
- * when the plugin is unloaded
+ * @type_register_func: A function that register a #GType and returns it
+ * @inunload: a function of type void (*unload) (FsPlugin * plugin) to be
+ * called when the plugin is unloaded
  *
  * This macro is used to declare Farsight plugins and must be used once
  * in any farsight plugin.
-- 
1.5.6.5




More information about the farsight-commits mailing list