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

Document this, for 2.0 we should just remove that parameter.
This commit is contained in:
Sebastian Dröge 2016-01-06 16:21:40 +02:00
parent fb01dd000b
commit 5fe1b7efe3

View file

@ -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