From c87d6825ec0707fcfbc7a5b3fae971d7db35cf4d Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Sat, 3 Aug 2019 08:04:50 +0200
Subject: [PATCH] decoder/mad: add API documentation

---
 src/decoder/plugins/MadDecoderPlugin.cxx | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/decoder/plugins/MadDecoderPlugin.cxx b/src/decoder/plugins/MadDecoderPlugin.cxx
index 8bddf14be..3fb38e0b9 100644
--- a/src/decoder/plugins/MadDecoderPlugin.cxx
+++ b/src/decoder/plugins/MadDecoderPlugin.cxx
@@ -175,6 +175,11 @@ private:
 	gcc_pure
 	long TimeToFrame(SongTime t) const noexcept;
 
+	/**
+	 * Record the current frame's offset in the "frame_offsets"
+	 * buffer and go forward to the next frame, updating the
+	 * attributes "current_frame" and "timer".
+	 */
 	void UpdateTimerNextFrame() noexcept;
 
 	/**