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.
This commit is contained in:
Stefan Kost 2007-02-11 19:59:12 +00:00
parent 3ad87e0249
commit 85c81ea952
11 changed files with 77 additions and 18 deletions

View file

@ -1,3 +1,23 @@
2007-02-11 Stefan Kost <ensonic@users.sf.net>
* 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 <sebastien@moutte.net>
* gst/gstbin.h:(gst_bin_get_by_interface),
@ -178,6 +198,18 @@
* gst/gstplugin.h:
Fix and expand GstPluginDesc API docs.
2007-01-29 Stefan Kost <ensonic@users.sf.net>
* 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 <ensonic@users.sf.net>
* configure.ac:

2
common

@ -1 +1 @@
Subproject commit de43a8f3c629983e0bea0b8eb617e52ed35a6cda
Subproject commit 66d97715fc83888fd1b5469c569f0ef5bbea628b

View file

@ -263,6 +263,8 @@ gst_caps_get_type
<SECTION>
<FILE>gstchildproxy</FILE>
<TITLE>GstChildProxy</TITLE>
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
<SUBSECTION Standard>
GstChildProxy
GstChildProxyInterface
GST_CHILD_PROXY
GST_IS_CHILD_PROXY
GST_CHILD_PROXY_GET_INTERFACE

View file

@ -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

View file

@ -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;
}

View file

@ -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.
* <note>This function does not work reliably if optional properties for caps
* are included on one caps and omitted on the other.</note>
*
* 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)

View file

@ -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,

View file

@ -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;

View file

@ -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
*/

View file

@ -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)

View file

@ -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