From 636e022fed171c82f15f3d03749b5ee747633ce0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Sat, 27 Jan 2007 18:44:11 +0000 Subject: [PATCH] Document registry signals and make gtk-doc pick them up (#401381). Original commit message from CVS: * docs/gst/gstreamer.types.in: * gst/gstregistry.c: (gst_registry_class_init): Document registry signals and make gtk-doc pick them up (#401381). --- ChangeLog | 6 ++++++ docs/gst/gstreamer.types.in | 1 + gst/gstregistry.c | 17 +++++++++++++++++ 3 files changed, 24 insertions(+) diff --git a/ChangeLog b/ChangeLog index 4cbf91eab5..20316f43e6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2007-01-27 Tim-Philipp Müller + + * docs/gst/gstreamer.types.in: + * gst/gstregistry.c: (gst_registry_class_init): + Document registry signals and make gtk-doc pick them up (#401381). + 2007-01-26 Tim-Philipp Müller * docs/pwg/building-testapp.xml: diff --git a/docs/gst/gstreamer.types.in b/docs/gst/gstreamer.types.in index 56b56fb65a..e2061bdcaf 100644 --- a/docs/gst/gstreamer.types.in +++ b/docs/gst/gstreamer.types.in @@ -17,6 +17,7 @@ gst_ghost_pad_get_type gst_implements_interface_get_type gst_index_factory_get_type gst_index_get_type +gst_registry_get_type % these are not GObject derived types ! % gst_mini_object_get_type diff --git a/gst/gstregistry.c b/gst/gstregistry.c index df240e30d9..e3599ee742 100644 --- a/gst/gstregistry.c +++ b/gst/gstregistry.c @@ -145,10 +145,27 @@ gst_registry_class_init (GstRegistryClass * klass) parent_class = g_type_class_peek_parent (klass); + /** + * GstRegistry::plugin-added: + * @registry: the registry that emitted the signal + * @plugin: the plugin that has been added + * + * Signals that a plugin has been added to the registry (possibly + * replacing a previously-added one by the same name) + */ gst_registry_signals[PLUGIN_ADDED] = g_signal_new ("plugin-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRegistryClass, plugin_added), NULL, NULL, gst_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER); + + /** + * GstRegistry::feature-added: + * @registry: the registry that emitted the signal + * @feature: the feature that has been added + * + * Signals that a feature has been added to the registry (possibly + * replacing a previously-added one by the same name) + */ gst_registry_signals[FEATURE_ADDED] = g_signal_new ("feature-added", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstRegistryClass, feature_added),