bufferpool: update docs a little
authorWim Taymans <wim.taymans@collabora.co.uk>
Mon, 18 Jun 2012 10:15:57 +0000 (12:15 +0200)
committerWim Taymans <wim.taymans@collabora.co.uk>
Mon, 18 Jun 2012 10:15:57 +0000 (12:15 +0200)
gst/gstbufferpool.c

index ab212b5..08461b0 100644 (file)
@@ -520,6 +520,10 @@ wrong_config:
  * the pool. A default and mandatory set of parameters can be configured with
  * gst_buffer_pool_config_set(). This function takes ownership of @config.
  *
+ * If the parameters in @config can not be set exactly, this function returns
+ * FALSE and will try to update as much state as possible. The new state can
+ * then be retrieved and refined with gst_buffer_pool_config_get().
+ *
  * Returns: TRUE when the configuration could be set.
  */
 gboolean