clock: adjust/unadjust_with_calibration() have a clock parameter but it's useless

Document this, for 2.0 we should just remove that parameter.

diff --git a/gst/gstclock.c b/gst/gstclock.c
index b89e255bb1176c0046da655067e1bd50db33e638..7e9be2f6c1a33c3ba66c3cf9e3e911c426fc6c56 100644 (file)
--- a/gst/gstclock.c
+++ b/gst/gstclock.c
@@ -847,9 +847,10 @@ gst_clock_get_resolution (GstClock * clock)
   return 1;
 }
 
+/* FIXME 2.0: Remove clock parameter below */
 /**
  * gst_clock_adjust_with_calibration:
- * @clock: a #GstClock to use
+ * @clock: (allow-none): a #GstClock to use
  * @internal_target: a clock time
  * @cinternal: a reference internal time
  * @cexternal: a reference external time
@@ -863,6 +864,8 @@ gst_clock_get_resolution (GstClock * clock)
  * current calibration parameters, but doesn't ensure a monotonically
  * increasing result as gst_clock_adjust_unlocked() does.
  *
+ * Note: The @clock parameter is unused and can be NULL
+ *
  * Returns: the converted time of the clock.
  *
  * Since: 1.6
@@ -937,9 +940,10 @@ gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
   return priv->last_time;
 }
 
+/* FIXME 2.0: Remove clock parameter below */
 /**
  * gst_clock_unadjust_with_calibration:
- * @clock: a #GstClock to use
+ * @clock: (allow-none): a #GstClock to use
  * @external_target: a clock time
  * @cinternal: a reference internal time
  * @cexternal: a reference external time
@@ -952,6 +956,8 @@ gst_clock_adjust_unlocked (GstClock * clock, GstClockTime internal)
  * same calculation as gst_clock_unadjust_unlocked() when called using the
  * current calibration parameters.
  *
+ * Note: The @clock parameter is unused and can be NULL
+ *
  * Returns: the converted time of the clock.
  *
  * Since: 1.8