docs: clarify GstTuner docs in two places
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Sun, 4 Oct 2009 23:33:32 +0000 (00:33 +0100)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Wed, 7 Oct 2009 09:15:52 +0000 (10:15 +0100)
gst-libs/gst/interfaces/tuner.c

index dbefde1..a7ba61a 100644 (file)
@@ -221,7 +221,8 @@ gst_tuner_list_channels (GstTuner * tuner)
  * @tuner: the #GstTuner (a #GstElement) that owns the channel.
  * @channel: the channel to tune to.
  *
- * Tunes the object to the given channel.
+ * Tunes the object to the given channel, which should be one of the
+ * channels returned by gst_tuner_list_channels().
  */
 
 void
@@ -293,7 +294,8 @@ gst_tuner_list_norms (GstTuner * tuner)
  * @tuner: the #GstTuner (a #GstElement) to set the norm on.
  * @norm: the norm to use for the current channel.
  *
- * Changes the video norm on this tuner to the given norm.
+ * Changes the video norm on this tuner to the given norm, which should be
+ * one of the norms returned by gst_tuner_list_norms().
  */
 
 void