docs: give a practical example for the gst_object_has_anchestor
authorStefan Kost <ensonic@users.sf.net>
Mon, 6 Sep 2010 14:01:19 +0000 (17:01 +0300)
committerStefan Kost <ensonic@users.sf.net>
Mon, 6 Sep 2010 14:02:45 +0000 (17:02 +0300)
gst/gstobject.c

index 7cdb5dc5e00eb6c007fb431f3982822f65efd039..dabb894e038c20ae9d0ee007667370563db43752 100644 (file)
@@ -921,7 +921,7 @@ gst_object_unparent (GstObject * object)
  * @ancestor: a #GstObject to check as ancestor
  *
  * Check if @object has an ancestor @ancestor somewhere up in
- * the hierarchy.
+ * the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
  *
  * Returns: TRUE if @ancestor is an ancestor of @object.
  *