From 431c80f4f042bcc2d549d82b28f86c06e9b1cde6 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Tue, 24 Dec 2013 23:45:38 +0100
Subject: pcm/Dither: add API documentation

---
 src/pcm/PcmDither.hxx | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'src/pcm/PcmDither.hxx')

diff --git a/src/pcm/PcmDither.hxx b/src/pcm/PcmDither.hxx
index 0d81b8794..fdcdb1f6a 100644
--- a/src/pcm/PcmDither.hxx
+++ b/src/pcm/PcmDither.hxx
@@ -39,9 +39,27 @@ public:
 			  const int32_t *src_end);
 
 private:
+	/**
+	 * Shift the given sample by #scale_bits to the right, and
+	 * apply dithering.
+	 *
+	 * @param T the input sample type
+	 * @param MIN the minimum input sample value
+	 * @param MAX the maximum input sample value
+	 * @param scale_bits the number of bits to be discarded
+	 * @param sample the input sample value
+	 */
 	template<typename T, T MIN, T MAX, unsigned scale_bits>
 	T Dither(T sample);
 
+	/**
+	 * Convert the given sample from one sample format to another,
+	 * discarding bits.
+	 *
+	 * @param ST the input #SampleTraits class
+	 * @param ST the output #SampleTraits class
+	 * @param sample the input sample value
+	 */
 	template<typename ST, typename DT>
 	typename DT::value_type DitherConvert(typename ST::value_type sample);
 
-- 
cgit v1.2.3