decoder/mad: add API documentation

2019-08-03 08:04:50 +02:00 · 2019-08-03 08:04:50 +02:00 · c87d6825ec
commit c87d6825ec
parent 00830a20e3
1 changed files with 5 additions and 0 deletions
--- 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;

 	/**