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

db/Song: update API documentation for SimpleDatabasePlugin

Browse Source
This commit is contained in:
Max Kellermann 2014-02-25 22:16:20 +01:00
parent 5f262da09d
commit d86cc5bf42
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/db/Song.hxx
View File

@ -35,7 +35,8 @@ class DetachedSong;
class Storage; class Storage;
/** /**
* A song file inside the configured music directory. * A song file inside the configured music directory. Internal
* #SimpleDatabase class.
*/ */
struct Song { struct Song {
/** /**
@ -51,9 +52,8 @@ struct Song {
Tag tag; Tag tag;
/** /**
* The #Directory that contains this song. May be nullptr if * The #Directory that contains this song. Must be
* the current database plugin does not manage the parent * non-nullptr. directory this way.
* directory this way.
*/ */
Directory *const parent; Directory *const parent;
@ -71,8 +71,7 @@ struct Song {
unsigned end_ms; unsigned end_ms;
/** /**
* The file name. If #parent is nullptr, then this is the URI * The file name.
* relative to the music directory.
*/ */
char uri[sizeof(int)]; char uri[sizeof(int)];