summaryrefslogtreecommitdiff
path: root/gst/gstchildproxy.h
diff options
context:
space:
mode:
authorMathieu Duponchelle <mathieu@centricular.com>2021-02-11 16:04:01 +0100
committerMathieu Duponchelle <mathieu@centricular.com>2021-02-11 16:43:14 +0100
commitc53ea138c640c39389e78764a95eb602555faa22 (patch)
treedafdda7acc29e6a5ba4a2c3b39904484a559e328 /gst/gstchildproxy.h
parent3f5042d74e989c7f7c245274eec28ab70ea967a3 (diff)
docs: standardize GstCapsFeatures, GstChildProxy documentation
* Don't mention explicitly that API is MT safe, this implies that other API is not. GStreamer API is assumed to be MT safe, thread safety should only be explicitly mentioned when API is *not* MT safe * Document virtual methods in standalone comments, in order to properly annotate them * Don't repeat what annotations are stating with respect to ownership transfer, nullability * Misc cleanup / typo fixes / addition of links Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/755>
Diffstat (limited to 'gst/gstchildproxy.h')
-rw-r--r--gst/gstchildproxy.h51
1 files changed, 48 insertions, 3 deletions
diff --git a/gst/gstchildproxy.h b/gst/gstchildproxy.h
index 57e30124d5..47444fcbcb 100644
--- a/gst/gstchildproxy.h
+++ b/gst/gstchildproxy.h
@@ -44,9 +44,6 @@ typedef struct _GstChildProxyInterface GstChildProxyInterface;
/**
* GstChildProxyInterface:
* @parent: parent interface type.
- * @get_child_by_name: virtual method to fetch the child by name
- * @get_child_by_index: virtual method to fetch the child by index
- * @get_children_count: virtual method to get the children count
*
* #GstChildProxy interface.
*/
@@ -55,12 +52,60 @@ struct _GstChildProxyInterface
GTypeInterface parent;
/* methods */
+
+ /**
+ * #GstChildProxyInterface::get_child_by_name:
+ * @parent: the #GstChildProxy
+ * @name: the name of the child to fetch
+ *
+ * Fetch a child object by name
+ *
+ * Returns: (transfer full) (nullable): the child object
+ */
GObject * (*get_child_by_name) (GstChildProxy * parent, const gchar * name);
+
+ /**
+ * #GstChildProxyInterface::get_child_by_index:
+ * @parent: the #GstChildProxy
+ * @index: the index of the child to fetch
+ *
+ * Fetch a child object by index
+ *
+ * Returns: (transfer full) (nullable): the child object
+ */
GObject * (*get_child_by_index) (GstChildProxy * parent, guint index);
+
+ /**
+ * #GstChildProxyInterface::get_children_count:
+ * @parent: the #GstChildProxy
+ *
+ * Get the number of children in @parent
+ *
+ * Returns: the number of children
+ */
guint (*get_children_count) (GstChildProxy * parent);
+
/*< private >*/
/* signals */
+
+ /**
+ * #GstChildProxyInterface::child_added:
+ * @parent: the #GstChildProxy
+ * @child: the child object
+ * @name: the name of the child object
+ *
+ * Called when @child is added to @parent
+ */
void (*child_added) (GstChildProxy * parent, GObject * child, const gchar * name);
+
+ /**
+ * #GstChildProxyInterface::child_removed:
+ * @parent: the #GstChildProxy
+ * @child: the child object
+ * @name: the name of the child object
+ *
+ * Called when @child is removed from @parent
+ */
void (*child_removed) (GstChildProxy * parent, GObject * child, const gchar * name);
/*< private >*/