decoder/mad: add API documentation

c87d6825 · Max Kellermann · 00830a20 · c87d6825
Commit c87d6825 authored Aug 03, 2019 by Max Kellermann
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 0 deletions

MadDecoderPlugin.cxx src/decoder/plugins/MadDecoderPlugin.cxx +5 -0

No files found.
--- 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;

 	/**