Commit d86cc5bf authored by Max Kellermann's avatar Max Kellermann

db/Song: update API documentation for SimpleDatabasePlugin

parent 5f262da0
...@@ -35,7 +35,8 @@ class DetachedSong; ...@@ -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 { ...@@ -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 { ...@@ -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)];
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment