decoder_internal.h: more API documentation

2011-09-21 22:59:11 +02:00 · 2011-09-21 22:59:11 +02:00 · fb19210cfd
parent b0b2c5b3e0
commit fb19210cfd
1 changed files with 5 additions and 0 deletions
--- a/src/decoder_internal.h
+++ b/src/decoder_internal.h
@ -36,6 +36,11 @@ struct decoder {
 	 */
 	double timestamp;

+	/**
+	 * This flag is set by decoder_seek_where(), and checked by
+	 * decoder_command_finished().  It is used to clean up after
+	 * seeking.
+	 */
 	bool seeking;

 	/**