Documentation: add Itdb_SPLPref

1 files changed, 24 insertions, 10 deletions

diff --git a/src/itdb.h b/src/itdb.h
index c55a13b..6762c1a 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -605,18 +605,32 @@ typedef enum {
     ITDB_SPLFIELD_ALBUMARTIST = 0x47
 } ItdbSPLField;
 
+/**
+ * Itdb_SPLPref:
+ * @liveupdate:         Live Updating
+ * @checkrules:         Match this number of rules.  If set to 0, ignore rules.
+ * @checklimits:        Limit to this number of @limittype.  If 0, no limits.
+ * @limittype:          an #ItdbLimitType
+ * @limitsort:          an #ItdbLimitSort
+ * @limitvalue:         The value typed next to "Limit type"
+ * @matchcheckedonly:   Match only checked songs
+ * @reserved_int1:      Reserved for future use
+ * @reserved_int2:      Reserved for future use
+ * @reserved1:          Reserved for future use
+ * @reserved2:          Reserved for future use
+ *
+ * Smart Playlist preferences are for various flags that are not strictly smart
+ * playlist "rules."
+ */
 struct _Itdb_SPLPref
 {
-    guint8  liveupdate;        /* "live Updating" check box */
-    guint8  checkrules;        /* "Match X of the following
-				  conditions" check box */
-    guint8  checklimits;       /* "Limit To..." check box */
-    guint32 limittype;         /* See types defined above */
-    guint32 limitsort;         /* See types defined above */
-    guint32 limitvalue;        /* The value typed next to "Limit
-				  type" */
-    guint8  matchcheckedonly;  /* "Match only checked songs" check box */
-    /* reserved for future use */
+    guint8  liveupdate;
+    guint8  checkrules;
+    guint8  checklimits;
+    guint32 limittype;
+    guint32 limitsort;
+    guint32 limitvalue;
+    guint8  matchcheckedonly;
     gint32 reserved_int1;
     gint32 reserved_int2;
     gpointer reserved1;