From 599a56217054c139108076725d570a58782f9ce6 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Thu, 3 Jan 2013 21:38:38 +0100
Subject: cue_parser: add code comments
---
src/cue/cue_parser.c | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
(limited to 'src/cue')
diff --git a/src/cue/cue_parser.c b/src/cue/cue_parser.c
index 898c7b829..4031d6c42 100644
--- a/src/cue/cue_parser.c
+++ b/src/cue/cue_parser.c
@@ -58,8 +58,27 @@ struct cue_parser {
char *filename;
- struct song *current, *previous, *finished;
-
+ /**
+ * The song currently being edited.
+ */
+ struct song *current;
+
+ /**
+ * The previous song. It is remembered because its end_time
+ * will be set to the current song's start time.
+ */
+ struct song *previous;
+
+ /**
+ * A song that is completely finished and can be returned to
+ * the caller via cue_parser_get().
+ */
+ struct song *finished;
+
+ /**
+ * Set to true after previous.end_time has been updated to the
+ * start time of the current song.
+ */
bool last_updated;
};
--
cgit v1.2.3