[vlc-commits] clock: document internal functions

[Thomas Guillem]

vlc | branch: master | Thomas Guillem <thomas at gllm.fr> | Tue Mar  9 09:56:07 2021 +0100| [a8267506ca420aa263e2fdce5e5b334e27d18279] | committer: Thomas Guillem

clock: document internal functions

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=a8267506ca420aa263e2fdce5e5b334e27d18279
---

 src/clock/clock.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/clock/clock.h b/src/clock/clock.h
index e737339169..f780d448bc 100644
--- a/src/clock/clock.h
+++ b/src/clock/clock.h
@@ -74,8 +74,19 @@ void vlc_clock_main_Abort(vlc_clock_main_t *main_clock);
  */
 void vlc_clock_main_Reset(vlc_clock_main_t *main_clock);
 
+/**
+ * Set the first PCR of the input
+ *
+ * It is used to calculate the input delay when output clocks are starting.
+ */
 void vlc_clock_main_SetFirstPcr(vlc_clock_main_t *main_clock,
                                 vlc_tick_t system_now, vlc_tick_t ts);
+
+/**
+ * Set the input dejitter (or pts_delay)
+ *
+ * It is used to calculate the input delay when output clocks are starting.
+ */
 void vlc_clock_main_SetInputDejitter(vlc_clock_main_t *main_clock,
                                      vlc_tick_t delay);