Documentation: add Itdb_SPLRule

1 files changed, 35 insertions, 11 deletions

diff --git a/src/itdb.h b/src/itdb.h
index 6762c1a..60b4886 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -637,21 +637,45 @@ struct _Itdb_SPLPref
     gpointer reserved2;
 };
 
+/**
+ * Itdb_SPLRule:
+ * @field:          an #ItdbSPLFieldType
+ * @action:         an #ItdbSPLActionType
+ * @string:         data in UTF8
+ * @fromvalue:      from value
+ * @fromdate:       from date
+ * @fromunits:      from units
+ * @tovalue:        to value
+ * @todate:         to date
+ * @tounits:        to units
+ * @unk052:         Unknown
+ * @unk056:         Unknown
+ * @unk060:         Unknown
+ * @unk064:         Unknown
+ * @unk068:         Unknown
+ * @reserved_int1:  Reserved for future use
+ * @reserved_int2:  Reserved for future use
+ * @reserved1:      Reserved for future use
+ * @reserved2:      Reserved for future use
+ *
+ * Smart Playlist Rule
+ *
+ * The from and to fields require some explanation.  If @field is a date type,
+ * then @value would be set to 0x2dae2dae2dae2dae, @date would be a number,
+ * (e.g. 2 or -2), and @units would be a time unit in seconds (e.g. one week
+ * would be 604800).  If @field is an integer comparison, like rating = 60 (i.e.
+ * 3 stars), then @value would be the value we care about (e.g. 60), @date would
+ * be 0, and @units would be 1.  Binary AND types are similar, @value is the
+ * important part, with @date = 0 and @units = 1.  Clear as mud, right?
+ *
+ * For more details see <ulink
+ * url="http://ipodlinux.org/ITunesDB.html&num;Smart_Playlist_Rule_Values">ipodlinux.org</ulink>.
+ */
 struct _Itdb_SPLRule
 {
     guint32 field;
     guint32 action;
-    gchar *string;             /* data in UTF8  */
-    /* from and to are pretty stupid.. if it's a date type of field,
-       then
-         value = 0x2dae2dae2dae2dae,
-         date = some number, like 2 or -2
-         units = unit in seconds, like 604800 = a week
-       but if this is actually some kind of integer comparison, like
-       rating = 60 (3 stars)
-         value = the value we care about
-	 date = 0
-	 units = 1 */
+    gchar *string;
     guint64 fromvalue;
     gint64 fromdate;
     guint64 fromunits;