From 73264e04ce8666c3ea80e33cc70b360e45c0f587 Mon Sep 17 00:00:00 2001 From: Anna Schumaker Date: Mon, 15 Sep 2014 08:26:52 -0400 Subject: [PATCH] playlist: Add doxygen comments. Signed-off-by: Anna Schumaker --- core/playlist.cpp | 3 ++- include/core/playlist.h | 48 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 49 insertions(+), 2 deletions(-) diff --git a/core/playlist.cpp b/core/playlist.cpp index 06629d74..ad7b6df1 100644 --- a/core/playlist.cpp +++ b/core/playlist.cpp @@ -1,4 +1,5 @@ -/* +/** + * @file * Copyright 2013 (c) Anna Schumaker. */ #include diff --git a/include/core/playlist.h b/include/core/playlist.h index 4efac4d0..f82a1efb 100644 --- a/include/core/playlist.h +++ b/include/core/playlist.h @@ -1,4 +1,5 @@ -/* +/** + * @file * Copyright 2013 (c) Anna Schumaker. */ #ifndef OCARINA_CORE_PLAYLIST_H @@ -9,15 +10,60 @@ #include +/** + * Namespace for accessing playlists. + */ namespace playlist { + /** + * Read playlist information from disk. + */ void init(); + + /** + * Check if a specific track is in a playlist. + * + * @param track The track in question. + * @param name The name of the playlist to check. + * @return True if the track is in the playlist, false otherwise. + */ bool has(Track *, const std::string &); + + /** + * Add a track to a playlist. + * + * @param track The track to add. + * @param name The name of the playlist to add to. + */ void add(Track *, const std::string &); + + /** + * Remove a track from a playlist. + * + * @param track The track to remove. + * @param name The name of the playlist to remove from. + */ void del(Track *, const std::string &); + + /** + * Use to change the currently queued playlist. + * + * @param name The name of the queue to queue up. + */ void select(const std::string &); + + /** + * Use to access specific tracks in a playlist. + * + * @param name The playlist to access. + * @return The IndexEntry containing the tracks. + */ IndexEntry *get_tracks(const std::string &); + + /** + * @return The playlist queue. + */ Queue *get_queue(); };