aboutsummaryrefslogtreecommitdiffstats
path: root/src/db
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2014-02-25 22:16:20 +0100
committerMax Kellermann <max@duempel.org>2014-02-25 22:16:20 +0100
commitd86cc5bf42bc22e1903f0d1fada5282e7ec9ac89 (patch)
treebde8b66d68fd83f8f59e1d8b5ed02178b596b8c8 /src/db
parent5f262da09d3e572bc9d8cc7570c249aab2ca0946 (diff)
downloadmpd-d86cc5bf42bc22e1903f0d1fada5282e7ec9ac89.tar.gz
mpd-d86cc5bf42bc22e1903f0d1fada5282e7ec9ac89.tar.xz
mpd-d86cc5bf42bc22e1903f0d1fada5282e7ec9ac89.zip
db/Song: update API documentation for SimpleDatabasePlugin
Diffstat (limited to 'src/db')
-rw-r--r--src/db/Song.hxx11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/db/Song.hxx b/src/db/Song.hxx
index d73c42e00..75fce20e9 100644
--- a/src/db/Song.hxx
+++ b/src/db/Song.hxx
@@ -35,7 +35,8 @@ class DetachedSong;
class Storage;
/**
- * A song file inside the configured music directory.
+ * A song file inside the configured music directory. Internal
+ * #SimpleDatabase class.
*/
struct Song {
/**
@@ -51,9 +52,8 @@ struct Song {
Tag tag;
/**
- * The #Directory that contains this song. May be nullptr if
- * the current database plugin does not manage the parent
- * directory this way.
+ * The #Directory that contains this song. Must be
+ * non-nullptr. directory this way.
*/
Directory *const parent;
@@ -71,8 +71,7 @@ struct Song {
unsigned end_ms;
/**
- * The file name. If #parent is nullptr, then this is the URI
- * relative to the music directory.
+ * The file name.
*/
char uri[sizeof(int)];