gst/gstregistry.c: Improve the documentation.

Original commit message from CVS:
* gst/gstregistry.c:
Improve the documentation.
This commit is contained in:
Stefan Kost 2008-04-23 13:55:01 +00:00
parent 6e367f59e2
commit 4b87b40779
3 changed files with 13 additions and 6 deletions

View file

@ -1,3 +1,8 @@
2008-04-23 Stefan Kost <ensonic@users.sf.net>
* gst/gstregistry.c:
Improve the documentation.
2008-04-23 Stefan Kost <ensonic@users.sf.net> 2008-04-23 Stefan Kost <ensonic@users.sf.net>
* gst/gstsegment.c: * gst/gstsegment.c:

2
common

@ -1 +1 @@
Subproject commit 19a5a66b2dff75e2820bb2b2d43368d4fcb6a94a Subproject commit f6fc3fa7643c03eb912f4e259d48c99b0e8d0aca

View file

@ -545,7 +545,8 @@ gst_registry_plugin_filter (GstRegistry * registry,
* If the first flag is set, only the first match is * If the first flag is set, only the first match is
* returned (as a list with a single object). * returned (as a list with a single object).
* *
* Returns: a GList of plugin features, gst_plugin_feature_list_free after use. * Returns: a #GList of #GstPluginFeature. Use gst_plugin_list_free() after
* usage.
* *
* MT safe. * MT safe.
*/ */
@ -652,8 +653,8 @@ gst_registry_find_feature (GstRegistry * registry, const gchar * name,
* *
* Retrieves a #GList of #GstPluginFeature of @type. * Retrieves a #GList of #GstPluginFeature of @type.
* *
* Returns: a #GList of #GstPluginFeature of @type. gst_plugin_feature_list_free * Returns: a #GList of #GstPluginFeature of @type. Use
* after usage. * gst_plugin_feature_list_free() after usage.
* *
* MT safe. * MT safe.
*/ */
@ -680,7 +681,7 @@ gst_registry_get_feature_list (GstRegistry * registry, GType type)
* Get a copy of all plugins registered in the given registry. The refcount * Get a copy of all plugins registered in the given registry. The refcount
* of each element in the list in incremented. * of each element in the list in incremented.
* *
* Returns: a #GList of #GstPlugin. gst_plugin_list_free after use. * Returns: a #GList of #GstPlugin. Use gst_plugin_list_free() after usage.
* *
* MT safe. * MT safe.
*/ */
@ -990,7 +991,8 @@ _gst_plugin_feature_filter_plugin_name (GstPluginFeature * feature,
* *
* Retrieves a #GList of features of the plugin with name @name. * Retrieves a #GList of features of the plugin with name @name.
* *
* Returns: a #GList of #GstPluginFeature. gst_plugin_feature_list_free() after usage. * Returns: a #GList of #GstPluginFeature. Use gst_plugin_feature_list_free()
* after usage.
*/ */
GList * GList *
gst_registry_get_feature_list_by_plugin (GstRegistry * registry, gst_registry_get_feature_list_by_plugin (GstRegistry * registry,