From d0c481e44e031e9668f06fdb2efcc84621704be8 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Fri, 19 Dec 2014 09:49:29 +0100
Subject: lib/ffmpeg/Time: add API documentation

---
 src/lib/ffmpeg/Time.hxx | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/lib')

diff --git a/src/lib/ffmpeg/Time.hxx b/src/lib/ffmpeg/Time.hxx
index fb845d7d9..0e6ba2e84 100644
--- a/src/lib/ffmpeg/Time.hxx
+++ b/src/lib/ffmpeg/Time.hxx
@@ -36,6 +36,9 @@ extern "C" {
 #undef SampleFormat
 #endif
 
+/**
+ * Convert a FFmpeg time stamp to a floating point value (in seconds).
+ */
 gcc_const
 static inline double
 FfmpegTimeToDouble(int64_t t, const AVRational time_base)
@@ -46,6 +49,9 @@ FfmpegTimeToDouble(int64_t t, const AVRational time_base)
 		/ (double)1024;
 }
 
+/**
+ * Convert a std::ratio to a #AVRational.
+ */
 template<typename Ratio>
 static inline constexpr AVRational
 RatioToAVRational()
@@ -53,6 +59,9 @@ RatioToAVRational()
 	return { Ratio::num, Ratio::den };
 }
 
+/**
+ * Convert a #SongTime to a FFmpeg time stamp with the given base.
+ */
 gcc_const
 static inline int64_t
 ToFfmpegTime(SongTime t, const AVRational time_base)
-- 
cgit v1.2.3