db/Directory: add DEVICE_* documentation

367d660c · Max Kellermann · 4d73e4d6 · 367d660c
Commit 367d660c authored Feb 26, 2014 by Max Kellermann
Show whitespace changes
Inline Side-by-side

Showing with 10 additions and 0 deletions

Directory.hxx src/db/plugins/simple/Directory.hxx +10 -0

No files found.
--- a/src/db/plugins/simple/Directory.hxx
+++ b/src/db/plugins/simple/Directory.hxx
@@ -28,7 +28,17 @@

 #include <string>

+/**
+ * Virtual directory that is really an archive file or a folder inside
+ * the archive (special value for Directory::device).
+ */
 static constexpr unsigned DEVICE_INARCHIVE = -1;
+
+/**
+ * Virtual directory that is really a song file with one or more "sub"
+ * songs as specified by DecoderPlugin::container_scan() (special
+ * value for Directory::device).
+ */
 static constexpr unsigned DEVICE_CONTAINER = -2;

 #define directory_for_each_child(pos, directory) \