diff options
author | Max Kellermann <max@musicpd.org> | 2016-10-26 17:07:52 +0200 |
---|---|---|
committer | Max Kellermann <max@musicpd.org> | 2016-10-26 17:07:52 +0200 |
commit | 6135f0763b976829ddc8335f08258e6c6984fc6a (patch) | |
tree | 0153b4fa9e2b56b8f49892abebd346890d8ffdf1 /src/playlist/cue | |
parent | 307964d8741d9d37e0ba54c6ddcbc1c84a4a17e1 (diff) |
playlist/cue/CueParser: update API documentation
Diffstat (limited to 'src/playlist/cue')
-rw-r--r-- | src/playlist/cue/CueParser.hxx | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/src/playlist/cue/CueParser.hxx b/src/playlist/cue/CueParser.hxx index 950d96274..cdd08fc9c 100644 --- a/src/playlist/cue/CueParser.hxx +++ b/src/playlist/cue/CueParser.hxx @@ -83,34 +83,33 @@ class CueParser { /** * A song that is completely finished and can be returned to - * the caller via cue_parser_get(). + * the caller via Get(). */ std::unique_ptr<DetachedSong> finished; /** - * Tracks whether cue_parser_finish() has been called. If - * true, then all remaining (partial) results will be - * delivered by cue_parser_get(). + * Tracks whether Finish() has been called. If true, then all + * remaining (partial) results will be delivered by Get(). */ bool end = false; public: /** * Feed a text line from the CUE file into the parser. Call - * cue_parser_get() after this to see if a song has been finished. + * Get() after this to see if a song has been finished. */ void Feed(const char *line); /** * Tell the parser that the end of the file has been reached. Call - * cue_parser_get() after this to see if a song has been finished. + * Get() after this to see if a song has been finished. * This procedure must be done twice! */ void Finish(); /** - * Check if a song was finished by the last cue_parser_feed() or - * cue_parser_finish() call. + * Check if a song was finished by the last Feed() or Finish() + * call. * * @return a song object that must be freed by the caller, or NULL if * no song was finished at this time |