summaryrefslogtreecommitdiff
path: root/music.h
diff options
context:
space:
mode:
authorJon Bergli Heier <snakebite@jvnv.net>2011-01-04 03:17:45 +0100
committerJon Bergli Heier <snakebite@jvnv.net>2011-01-04 03:17:45 +0100
commitf0db6a4e4e6b3059c6553b819ac8788b62486103 (patch)
treec449ef54f745c4a4994d815579c69c0790bc26b1 /music.h
parent2b03b8ef2b5002f00960d17c8f1f634eb3a3a70f (diff)
Added Doxyfile and documentation comments in various places.
Diffstat (limited to 'music.h')
-rw-r--r--music.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/music.h b/music.h
index c019136..ed47657 100644
--- a/music.h
+++ b/music.h
@@ -9,19 +9,23 @@
namespace fs = boost::filesystem;
+//! Generalized abstract class for music content.
class MusicListing {
public:
typedef boost::shared_ptr<MusicListing> p;
fs::path path;
+ //! Render the content for HTTP transport.
virtual void render(HTTP::Connection::p req) = 0;
};
+//! Represents a track.
class MusicTrack : public MusicListing {
public:
MusicTrack(const fs::path path);
virtual void render(HTTP::Connection::p req);
};
+//! Represents a directory.
class MusicDirectory : public MusicListing {
public:
typedef boost::shared_ptr<MusicDirectory> p;