utils: Add more details about gst_element_get_compatible_pad
authorEdward Hervey <bilboed@bilboed.com>
Thu, 8 Jul 2010 14:24:21 +0000 (16:24 +0200)
committerEdward Hervey <bilboed@bilboed.com>
Fri, 16 Jul 2010 13:30:22 +0000 (15:30 +0200)
gst/gstutils.c

index 456d53b..7b3ac98 100644 (file)
@@ -1090,6 +1090,10 @@ gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
  * guaranteed that linking the pads will work, though it should work in most
  * cases.
  *
+ * This function will first attempt to find a compatible unlinked ALWAYS pad,
+ * and if none can be found, it will request a compatible REQUEST pad by looking
+ * at the templates of @element.
+ *
  * Returns: the #GstPad to which a link can be made, or %NULL if one cannot be
  * found. gst_object_unref() after usage.
  */