documentation changes (thx Ross)
authorBenjamin Otte <otte@gnome.org>
Sun, 30 Mar 2003 18:30:07 +0000 (18:30 +0000)
committerBenjamin Otte <otte@gnome.org>
Sun, 30 Mar 2003 18:30:07 +0000 (18:30 +0000)
Original commit message from CVS:
documentation changes (thx Ross)

gst/gstpad.c

index 8cb37ce..1c21465 100644 (file)
@@ -3034,10 +3034,14 @@ gst_pad_query_default (GstPad *pad, GstQueryType type,
  * gst_pad_query:
  * @pad: a #GstPad to invoke the default query on.
  * @type: the #GstQueryType of the query to perform.
- * @format: a pointer to the #GstFormat of the result.
+ * @format: a pointer to the #GstFormat asked for.
+ *          On return contains the #GstFormat used.
  * @value: a pointer to the result.
  *
- * Queries a pad for one of the available properties.
+ * Queries a pad for one of the available properties. The format will be
+ * adjusted to the actual format used when specifying formats such as 
+ * GST_FORMAT_DEFAULT.
+ * FIXME: Tell if the format can be adjusted when specifying a definite format.
  *
  * Returns: TRUE if the query could be performed.
  */