oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

playlist/cue/CueParser: update API documentation

Browse Source
This commit is contained in:
Max Kellermann
2016-10-26 17:07:52 +02:00
parent 307964d874
commit 6135f0763b
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/playlist/cue/CueParser.hxx
View File

@@ -83,34 +83,33 @@ class CueParser {
/** /**
* A song that is completely finished and can be returned to * 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; std::unique_ptr<DetachedSong> finished;
/** /**
* Tracks whether cue_parser_finish() has been called. If * Tracks whether Finish() has been called. If true, then all
* true, then all remaining (partial) results will be * remaining (partial) results will be delivered by Get().
* delivered by cue_parser_get().
*/ */
bool end = false; bool end = false;
public: public:
/** /**
* Feed a text line from the CUE file into the parser. Call * 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); void Feed(const char *line);
/** /**
* Tell the parser that the end of the file has been reached. Call * 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! * This procedure must be done twice!
*/ */
void Finish(); void Finish();
/** /**
* Check if a song was finished by the last cue_parser_feed() or * Check if a song was finished by the last Feed() or Finish()
* cue_parser_finish() call. * call.
* *
* @return a song object that must be freed by the caller, or NULL if * @return a song object that must be freed by the caller, or NULL if
* no song was finished at this time * no song was finished at this time