Documentation: add ItdbSPLField

1 files changed, 75 insertions, 42 deletions

diff --git a/src/itdb.h b/src/itdb.h
index f3b6d01..216599a 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -515,49 +515,82 @@ typedef enum {
 #define ITDB_SPLACTION_LAST_SIDEREAL_YEAR 	31558150	// a "sidereal year" is the time it takes the earth to reach the same point in space again, compared to the stars
 #endif
 
-/* Smartlist fields - Used for rules. */
+/**
+ * ItdbSPLField:
+ * @ITDB_SPLFIELD_SONG_NAME:        Song name (string)
+ * @ITDB_SPLFIELD_ALBUM:            Album (string)
+ * @ITDB_SPLFIELD_ARTIST:           Artist (string)
+ * @ITDB_SPLFIELD_BITRATE:          Bitrate (integer, e.g. from/to = 128)
+ * @ITDB_SPLFIELD_SAMPLE_RATE:      Sample rate (integer, e.g. from/to = 44100)
+ * @ITDB_SPLFIELD_YEAR:             Year (integer, e.g. from/to = 2004)
+ * @ITDB_SPLFIELD_GENRE:            Genre (string)
+ * @ITDB_SPLFIELD_KIND:             File type (string, e.g. MP3-File)
+ * @ITDB_SPLFIELD_DATE_MODIFIED:    Date modified (integer, e.g.
+ *                                  from/to = bcf93280 == is before 6/19/2004)
+ * @ITDB_SPLFIELD_TRACKNUMBER:      Track number (integer, e.g. from/to = 2)
+ * @ITDB_SPLFIELD_SIZE:             Size (integer, e.g.
+ *                                  from/to = 0x00600000 for 6MB)
+ * @ITDB_SPLFIELD_TIME:             Time (integer, e.g.
+ *                                  from/to = 83999 for 1:23/83 seconds)
+ * @ITDB_SPLFIELD_COMMENT:          Comment (string)
+ * @ITDB_SPLFIELD_DATE_ADDED:       Date added (integer, e.g.
+ *                                  from/to = bcfa83ff == is after 6/19/2004)
+ * @ITDB_SPLFIELD_COMPOSER:         Composer (string)
+ * @ITDB_SPLFIELD_PLAYCOUNT:        Playcount (integer, e.g. from/to = 1)
+ * @ITDB_SPLFIELD_LAST_PLAYED:      Date last played (integer, e.g.
+ *                                  from = bcfa83ff (6/19/2004)
+ *                                  to = 0xbcfbd57f (6/20/2004))
+ * @ITDB_SPLFIELD_DISC_NUMBER:      Disc number (integer, e.g. from/to = 1)
+ * @ITDB_SPLFIELD_RATING:           Rating (integer, e.g.
+ *                                  from/to = 60 (3 stars))
+ * @ITDB_SPLFIELD_COMPILATION:      Compilation (integer, e.g.
+ *                                  is set -> ITDB_SPLACTION_IS_INT/from=1,
+ *                                  not set -> ITDB_SPLACTION_IS_NOT_INT/from=1)
+ * @ITDB_SPLFIELD_BPM:              Beats per minute (integer, e.g.
+ *                                  from/to = 60)
+ * @ITDB_SPLFIELD_GROUPING:         Grouping (string)
+ * @ITDB_SPLFIELD_PLAYLIST:         FIXME Unknown...not parsed correctly...
+ *                                  from/to = 0xb6fbad5f for "Purchased Music".
+ *                                  Extra data after "to"...
+ * @ITDB_SPLFIELD_VIDEO_KIND:       Logical integer (works on mediatype)
+ * @ITDB_SPLFIELD_TVSHOW:           TV Show (string)
+ * @ITDB_SPLFIELD_SEASON_NR:        Season number (integer)
+ * @ITDB_SPLFIELD_SKIPCOUNT:        Skipcount (integer)
+ * @ITDB_SPLFIELD_LAST_SKIPPED:     Last skipped (integer)
+ * @ITDB_SPLFIELD_ALBUMARTIST:      Album artist (string)
+ *
+ * Smart Playlist Fields, used for Smart Playlist Rules (#Itdb_SPLRule).
+ */
 typedef enum {
-    ITDB_SPLFIELD_SONG_NAME = 0x02,    /* String */
-    ITDB_SPLFIELD_ALBUM = 0x03,        /* String */
-    ITDB_SPLFIELD_ARTIST = 0x04,       /* String */
-    ITDB_SPLFIELD_BITRATE = 0x05,      /* Int (e.g. from/to = 128) */
-    ITDB_SPLFIELD_SAMPLE_RATE = 0x06,  /* Int  (e.g. from/to = 44100) */
-    ITDB_SPLFIELD_YEAR = 0x07,         /* Int  (e.g. from/to = 2004) */
-    ITDB_SPLFIELD_GENRE = 0x08,        /* String */
-    ITDB_SPLFIELD_KIND = 0x09,         /* String */
-    ITDB_SPLFIELD_DATE_MODIFIED = 0x0a,/* Int (e.g. from/to = bcf93280 ==
-				     is before 6/19/2004)*/
-    ITDB_SPLFIELD_TRACKNUMBER = 0x0b,  /* Int (e.g. from = 1, to = 2) */
-    ITDB_SPLFIELD_SIZE = 0x0c,         /* Int (e.g. from/to = 0x00600000
-				     for 6MB) */
-    ITDB_SPLFIELD_TIME = 0x0d,         /* Int (e.g. from/to = 83999 for
-				     1:23/83 seconds) */
-    ITDB_SPLFIELD_COMMENT = 0x0e,      /* String */
-    ITDB_SPLFIELD_DATE_ADDED = 0x10,   /* Int (e.g. from/to = bcfa83ff ==
-				     is after 6/19/2004) */
-    ITDB_SPLFIELD_COMPOSER = 0x12,     /* String */
-    ITDB_SPLFIELD_PLAYCOUNT = 0x16,    /* Int  (e.g. from/to = 1) */
-    ITDB_SPLFIELD_LAST_PLAYED = 0x17,  /* Int/ (e.g. from = bcfa83ff (6/19/2004)
-				     to = 0xbcfbd57f (6/20/2004)) */
-    ITDB_SPLFIELD_DISC_NUMBER = 0x18,  /* Int  (e.g. from/to = 1) */
-    ITDB_SPLFIELD_RATING = 0x19,       /* Int/Stars Rating (e.g. from/to =
-                                     60 (3 stars)) */
-    ITDB_SPLFIELD_COMPILATION = 0x1f,  /* Int (e.g. is set ->
-				     ITDB_SPLACTION_IS_INT/from=1,
-				     is not set ->
-				     ITDB_SPLACTION_IS_NOT_INT/from=1) */
-    ITDB_SPLFIELD_BPM = 0x23,          /* Int  (e.g. from/to = 60) */
-    ITDB_SPLFIELD_GROUPING = 0x27,     /* String */
-    ITDB_SPLFIELD_PLAYLIST = 0x28,     /* FIXME - Unknown...not parsed
-				     correctly...from/to = 0xb6fbad5f
-				     for "Purchased Music".  Extra
-				     data after "to"... */
-    ITDB_SPLFIELD_VIDEO_KIND = 0x3c,   /* Logic Int */
-    ITDB_SPLFIELD_TVSHOW = 0x3e,       /* String */
-    ITDB_SPLFIELD_SEASON_NR = 0x3f,    /* Int */
-    ITDB_SPLFIELD_SKIPCOUNT = 0x44,    /* Int */
-    ITDB_SPLFIELD_LAST_SKIPPED = 0x45, /* Int */
-    ITDB_SPLFIELD_ALBUMARTIST = 0x47   /* String */
+    ITDB_SPLFIELD_SONG_NAME = 0x02,
+    ITDB_SPLFIELD_ALBUM = 0x03,
+    ITDB_SPLFIELD_ARTIST = 0x04,
+    ITDB_SPLFIELD_BITRATE = 0x05,
+    ITDB_SPLFIELD_SAMPLE_RATE = 0x06,
+    ITDB_SPLFIELD_YEAR = 0x07,
+    ITDB_SPLFIELD_GENRE = 0x08,
+    ITDB_SPLFIELD_KIND = 0x09,
+    ITDB_SPLFIELD_DATE_MODIFIED = 0x0a,
+    ITDB_SPLFIELD_TRACKNUMBER = 0x0b,
+    ITDB_SPLFIELD_SIZE = 0x0c,
+    ITDB_SPLFIELD_TIME = 0x0d,
+    ITDB_SPLFIELD_COMMENT = 0x0e,
+    ITDB_SPLFIELD_DATE_ADDED = 0x10,
+    ITDB_SPLFIELD_COMPOSER = 0x12,
+    ITDB_SPLFIELD_PLAYCOUNT = 0x16,
+    ITDB_SPLFIELD_LAST_PLAYED = 0x17,
+    ITDB_SPLFIELD_DISC_NUMBER = 0x18,
+    ITDB_SPLFIELD_RATING = 0x19,
+    ITDB_SPLFIELD_COMPILATION = 0x1f,
+    ITDB_SPLFIELD_BPM = 0x23,
+    ITDB_SPLFIELD_GROUPING = 0x27,
+    ITDB_SPLFIELD_PLAYLIST = 0x28,
+    ITDB_SPLFIELD_VIDEO_KIND = 0x3c,
+    ITDB_SPLFIELD_TVSHOW = 0x3e,
+    ITDB_SPLFIELD_SEASON_NR = 0x3f,
+    ITDB_SPLFIELD_SKIPCOUNT = 0x44,
+    ITDB_SPLFIELD_LAST_SKIPPED = 0x45,
+    ITDB_SPLFIELD_ALBUMARTIST = 0x47
 } ItdbSPLField;
 
 struct _Itdb_SPLPref