From 85c81ea952f07492ddf9332852d008e881e5d9c3 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Sun, 11 Feb 2007 19:59:12 +0000 Subject: [PATCH] docs/libs/Makefile.am: Fix path to core docs. Original commit message from CVS: * docs/libs/Makefile.am: Fix path to core docs. * gst/gstbin.c: (gst_bin_get_by_interface), (gst_bin_iterate_all_by_interface): Refix docs by also renaming 'interface' to 'iface' in implementation. * docs/gst/gstreamer-sections.txt: * gst/gstcaps.c: * gst/gstchildproxy.c: (gst_child_proxy_base_init): * gst/gstchildproxy.h: * gst/gstelementfactory.c: * gst/gstpadtemplate.h: * libs/gst/controller/gstcontroller.c: (gst_controlled_property_new): Document more. --- ChangeLog | 32 ++++++++++++++++++++++++++++++++ common | 2 +- docs/gst/gstreamer-sections.txt | 4 ++-- docs/libs/Makefile.am | 2 +- gst/gstbin.c | 16 ++++++++-------- gst/gstcaps.c | 4 ++-- gst/gstchildproxy.c | 14 ++++++++++++++ gst/gstchildproxy.h | 13 +++++++++++++ gst/gstelementfactory.c | 2 +- gst/gstpadtemplate.h | 4 ++-- libs/gst/controller/gstcontroller.c | 2 +- 11 files changed, 77 insertions(+), 18 deletions(-) diff --git a/ChangeLog b/ChangeLog index f96c6ee..93c7c15 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,23 @@ +2007-02-11 Stefan Kost + + * docs/libs/Makefile.am: + Fix path to core docs. + + * gst/gstbin.c: (gst_bin_get_by_interface), + (gst_bin_iterate_all_by_interface): + Refix docs by also renaming 'interface' to 'iface' in implementation. + + * docs/gst/gstreamer-sections.txt: + * gst/gstcaps.c: + * gst/gstchildproxy.c: (gst_child_proxy_base_init): + * gst/gstchildproxy.h: + * gst/gstelementfactory.c: + * gst/gstpadtemplate.h: + * libs/gst/controller/gstcontroller.c: + (gst_controlled_property_new): + Document more. + + 2007-02-10 Sébastien Moutte * gst/gstbin.h:(gst_bin_get_by_interface), @@ -180,6 +200,18 @@ 2007-01-29 Stefan Kost + * gst/gstcaps.c: + * gst/gstelementfactory.c: + * gst/gstpadtemplate.h: + api doc fixes + + * libs/gst/controller/gstcontroller.c: + (gst_controlled_property_new): + * tests/examples/controller/audio-example.c: + comment fixes + +2007-01-29 Stefan Kost + * configure.ac: comment about refining the xml deps diff --git a/common b/common index de43a8f..66d9771 160000 --- a/common +++ b/common @@ -1 +1 @@ -Subproject commit de43a8f3c629983e0bea0b8eb617e52ed35a6cda +Subproject commit 66d97715fc83888fd1b5469c569f0ef5bbea628b diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 176d057..9aa05eb 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -263,6 +263,8 @@ gst_caps_get_type
gstchildproxy GstChildProxy +GstChildProxy +GstChildProxyInterface gst_child_proxy_get_children_count gst_child_proxy_get_child_by_name gst_child_proxy_get_child_by_index @@ -276,8 +278,6 @@ gst_child_proxy_set gst_child_proxy_child_added gst_child_proxy_child_removed -GstChildProxy -GstChildProxyInterface GST_CHILD_PROXY GST_IS_CHILD_PROXY GST_CHILD_PROXY_GET_INTERFACE diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index cdcb003..461a0ea 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -51,7 +51,7 @@ SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" MKDB_OPTIONS= --output-format=xml --sgml-mode --ignore-files=trio # Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS=--extra-dir=../gst/html +FIXXREF_OPTIONS=--extra-dir=$(datadir)/gtk-doc/html/gstreamer-@GST_MAJORMINOR@ # Used for dependencies. HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.h diff --git a/gst/gstbin.c b/gst/gstbin.c index bc07fe1..94a1cb6 100644 --- a/gst/gstbin.c +++ b/gst/gstbin.c @@ -2645,7 +2645,7 @@ compare_interface (GstElement * element, gpointer interface) /** * gst_bin_get_by_interface: * @bin: a #GstBin - * @interface: the #GType of an interface + * @iface: the #GType of an interface * * Looks for an element inside the bin that implements the given * interface. If such an element is found, it returns the element. @@ -2658,17 +2658,17 @@ compare_interface (GstElement * element, gpointer interface) * Returns: A #GstElement inside the bin implementing the interface */ GstElement * -gst_bin_get_by_interface (GstBin * bin, GType interface) +gst_bin_get_by_interface (GstBin * bin, GType iface) { GstIterator *children; gpointer result; g_return_val_if_fail (GST_IS_BIN (bin), NULL); - g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface), NULL); + g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL); children = gst_bin_iterate_recurse (bin); result = gst_iterator_find_custom (children, (GCompareFunc) compare_interface, - (gpointer) interface); + (gpointer) iface); gst_iterator_free (children); return GST_ELEMENT_CAST (result); @@ -2677,7 +2677,7 @@ gst_bin_get_by_interface (GstBin * bin, GType interface) /** * gst_bin_iterate_all_by_interface: * @bin: a #GstBin - * @interface: the #GType of an interface + * @iface: the #GType of an interface * * Looks for all elements inside the bin that implements the given * interface. You can safely cast all returned elements to the given interface. @@ -2693,17 +2693,17 @@ gst_bin_get_by_interface (GstBin * bin, GType interface) * implementing the given interface, or NULL */ GstIterator * -gst_bin_iterate_all_by_interface (GstBin * bin, GType interface) +gst_bin_iterate_all_by_interface (GstBin * bin, GType iface) { GstIterator *children; GstIterator *result; g_return_val_if_fail (GST_IS_BIN (bin), NULL); - g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface), NULL); + g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface), NULL); children = gst_bin_iterate_recurse (bin); result = gst_iterator_filter (children, (GCompareFunc) compare_interface, - (gpointer) interface); + (gpointer) iface); return result; } diff --git a/gst/gstcaps.c b/gst/gstcaps.c index ed3eb42..c923e4b 100644 --- a/gst/gstcaps.c +++ b/gst/gstcaps.c @@ -1029,11 +1029,11 @@ gst_caps_is_always_compatible (const GstCaps * caps1, const GstCaps * caps2) * @subset: a #GstCaps * @superset: a potentially greater #GstCaps * - * Checks if all caps represented by @subset are also represented by @superset + * Checks if all caps represented by @subset are also represented by @superset. * This function does not work reliably if optional properties for caps * are included on one caps and omitted on the other. * - * Returns: TRUE if @subset is a subset of @superset + * Returns: %TRUE if @subset is a subset of @superset */ gboolean gst_caps_is_subset (const GstCaps * subset, const GstCaps * superset) diff --git a/gst/gstchildproxy.c b/gst/gstchildproxy.c index d5d6e39..c56fb2d 100644 --- a/gst/gstchildproxy.c +++ b/gst/gstchildproxy.c @@ -433,12 +433,26 @@ gst_child_proxy_base_init (gpointer g_class) if (!initialized) { /* create interface signals and properties here. */ + /** + * GstChildProxy::child-added: + * @child_proxy: the #GstChildProxy + * @object: the #GObject that was added + * + * Will be emitted after the @object was added to the @child_proxy. + */ signals[CHILD_ADDED] = g_signal_new ("child-added", G_TYPE_FROM_CLASS (g_class), G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstChildProxyInterface, child_added), NULL, NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, G_TYPE_OBJECT); + /** + * GstChildProxy::child-removed: + * @child_proxy: the #GstChildProxy + * @object: the #GObject that was removed + * + * Will be emitted after the @object was removed from the @child_proxy. + */ signals[CHILD_REMOVED] = g_signal_new ("child-removed", G_TYPE_FROM_CLASS (g_class), G_SIGNAL_RUN_FIRST, G_STRUCT_OFFSET (GstChildProxyInterface, diff --git a/gst/gstchildproxy.h b/gst/gstchildproxy.h index d507847..2fcb7ff 100644 --- a/gst/gstchildproxy.h +++ b/gst/gstchildproxy.h @@ -33,9 +33,22 @@ G_BEGIN_DECLS #define GST_IS_CHILD_PROXY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_CHILD_PROXY)) #define GST_CHILD_PROXY_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_CHILD_PROXY, GstChildProxyInterface)) +/** + * GstChildProxy: + * + * Opaque #GstChildProxy data structure. + */ typedef struct _GstChildProxy GstChildProxy; /* dummy object */ typedef struct _GstChildProxyInterface GstChildProxyInterface; +/** + * GstChildProxyInterface: + * @parent: parent interface type. + * @get_child_by_index: virtual method to fetch the child + * @get_children_count: virtual method to get the children count + * + * #GstChildProxyInterface interface. + */ struct _GstChildProxyInterface { GTypeInterface parent; diff --git a/gst/gstelementfactory.c b/gst/gstelementfactory.c index d62ac2f..9327812 100644 --- a/gst/gstelementfactory.c +++ b/gst/gstelementfactory.c @@ -602,7 +602,7 @@ __gst_element_factory_add_interface (GstElementFactory * elementfactory, * gst_element_factory_get_static_pad_templates: * @factory: a #GstElementFactory * - * Gets the #GList of padtemplates for this factory. + * Gets the #GList of #GstStaticPadTemplate for this factory. * * Returns: the padtemplates */ diff --git a/gst/gstpadtemplate.h b/gst/gstpadtemplate.h index ac455a8..922e6e0 100644 --- a/gst/gstpadtemplate.h +++ b/gst/gstpadtemplate.h @@ -75,7 +75,7 @@ typedef enum { * GST_PAD_TEMPLATE_DIRECTION: * @templ: the template to query * - * Get the direction of the padtemplate. + * Get the #GstPadDirection of the padtemplate. */ #define GST_PAD_TEMPLATE_DIRECTION(templ) (((GstPadTemplate *)(templ))->direction) @@ -83,7 +83,7 @@ typedef enum { * GST_PAD_TEMPLATE_PRESENCE: * @templ: the template to query * - * Get the presence of the padtemplate. + * Get the #GstPadPresence of the padtemplate. */ #define GST_PAD_TEMPLATE_PRESENCE(templ) (((GstPadTemplate *)(templ))->presence) diff --git a/libs/gst/controller/gstcontroller.c b/libs/gst/controller/gstcontroller.c index b81e776..88b33b6 100644 --- a/libs/gst/controller/gstcontroller.c +++ b/libs/gst/controller/gstcontroller.c @@ -367,7 +367,7 @@ gst_controlled_property_new (GObject * object, const gchar * name) GST_WARNING ("incomplete implementation for paramspec type '%s'", G_PARAM_SPEC_TYPE_NAME (pspec)); } - /* TODO what about adding a timedval with timestamp=0 and value=default + /* TODO what about adding a timed-val with timestamp=0 and value=default * a bit easier for interpolators, example: * first timestamp is at 5 * requested value if for timestamp=3 -- 2.7.4