Documentation: add ItdbSPLAction (NEEDS WORK)

1 files changed, 49 insertions, 29 deletions

diff --git a/src/itdb.h b/src/itdb.h
index eeb5db7..7437b27 100644
--- a/src/itdb.h
+++ b/src/itdb.h
@@ -366,28 +366,55 @@ typedef enum {
     ITDB_LIMITSORT_LOWEST_RATING = 0x80000017,        /* See note above */
 } ItdbLimitSort;
 
-/* Smartlist Actions - Used in the rules.
-Note by Otto (Samuel Wood):
- really this is a bitmapped field...
- high byte
- bit 0 = "string" values if set, "int" values if not set
- bit 1 = "not", or to negate the check.
- lower 2 bytes
- bit 0 = simple "IS" query
- bit 1 = contains
- bit 2 = begins with
- bit 3 = ends with
- bit 4 = greater than
- bit 5 = unknown, but probably greater than or equal to
- bit 6 = less than
- bit 7 = unknown, but probably less than or equal to
- bit 8 = a range selection
- bit 9 = "in the last"
+/**
+ * ItdbSPLAction:
+ * @ITDB_SPLACTION_IS_INT:              is integer ("Is Set" in iTunes)
+ * @ITDB_SPLACTION_IS_GREATER_THAN:     is greater than ("Is after" in iTunes)
+ * @ITDB_SPLACTION_IS_LESS_THAN:        is less than ("Is Before" in iTunes)
+ * @ITDB_SPLACTION_IS_IN_THE_RANGE:     is in the range
+ * @ITDB_SPLACTION_IS_IN_THE_LAST:      is in the last
+ * @ITDB_SPLACTION_BINARY_AND:          binary AND
+ * @ITDB_SPLACTION_IS_STRING:           is a string
+ * @ITDB_SPLACTION_CONTAINS:            contains
+ * @ITDB_SPLACTION_STARTS_WITH:         starts with
+ * @ITDB_SPLACTION_ENDS_WITH:           ends with
+ * @ITDB_SPLACTION_IS_NOT_INT:          is not an integer ("Is Not Set" in iTunes)
+ * @ITDB_SPLACTION_IS_NOT_GREATER_THAN: is not greater than (not in iTunes)
+ * @ITDB_SPLACTION_IS_NOT_LESS_THAN:    is not less than (not in iTunes)
+ * @ITDB_SPLACTION_IS_NOT_IN_THE_RANGE: is not in the range (not in iTunes)
+ * @ITDB_SPLACTION_IS_NOT_IN_THE_LAST:  is not in the last
+ * @ITDB_SPLACTION_IS_NOT:              is not
+ * @ITDB_SPLACTION_DOES_NOT_CONTAIN:    does not contain
+ * @ITDB_SPLACTION_DOES_NOT_START_WITH: does not start with (not in iTunes)
+ * @ITDB_SPLACTION_DOES_NOT_END_WITH:   does not end with (not in iTunes)
+ *
+ * Smartlist Actions used in smart playlist rules.
+ *
+ * Note by Otto (Samuel Wood):
+ * <informalexample>
+ *  <programlisting>
+ *  really this is a bitmapped field...
+ *  high byte
+ *  bit 0 = "string" values if set, "int" values if not set
+ *  bit 1 = "not", or to negate the check.
+ *  lower 2 bytes
+ *  bit 0 = simple "IS" query
+ *  bit 1 = contains
+ *  bit 2 = begins with
+ *  bit 3 = ends with
+ *  bit 4 = greater than
+ *  bit 5 = unknown, but probably greater than or equal to
+ *  bit 6 = less than
+ *  bit 7 = unknown, but probably less than or equal to
+ *  bit 8 = a range selection
+ *  bit 9 = "in the last"
+ *  </programlisting>
+ * </informalexample>
 */
 typedef enum {
-    ITDB_SPLACTION_IS_INT = 0x00000001,          /* "Is Set" in iTunes */
-    ITDB_SPLACTION_IS_GREATER_THAN = 0x00000010, /* "Is After" in iTunes */
-    ITDB_SPLACTION_IS_LESS_THAN = 0x00000040,    /* "Is Before" in iTunes */
+    ITDB_SPLACTION_IS_INT = 0x00000001,
+    ITDB_SPLACTION_IS_GREATER_THAN = 0x00000010,
+    ITDB_SPLACTION_IS_LESS_THAN = 0x00000040,
     ITDB_SPLACTION_IS_IN_THE_RANGE = 0x00000100,
     ITDB_SPLACTION_IS_IN_THE_LAST = 0x00000200,
     ITDB_SPLACTION_BINARY_AND = 0x00000400,
@@ -397,22 +424,15 @@ typedef enum {
     ITDB_SPLACTION_STARTS_WITH = 0x01000004,
     ITDB_SPLACTION_ENDS_WITH = 0x01000008,
 
-    ITDB_SPLACTION_IS_NOT_INT = 0x02000001,     /* "Is Not Set" in iTunes */
-
-    /* Note: Not available in iTunes 4.5 (untested on iPod) */
+    ITDB_SPLACTION_IS_NOT_INT = 0x02000001,
     ITDB_SPLACTION_IS_NOT_GREATER_THAN = 0x02000010,
-    /* Note: Not available in iTunes 4.5 (untested on iPod) */
     ITDB_SPLACTION_IS_NOT_LESS_THAN = 0x02000040,
-    /* Note: Not available in iTunes 4.5 (seems to work on iPod) */
     ITDB_SPLACTION_IS_NOT_IN_THE_RANGE = 0x02000100,
-
     ITDB_SPLACTION_IS_NOT_IN_THE_LAST = 0x02000200,
+
     ITDB_SPLACTION_IS_NOT = 0x03000001,
     ITDB_SPLACTION_DOES_NOT_CONTAIN = 0x03000002,
-
-    /* Note: Not available in iTunes 4.5 (seems to work on iPod) */
     ITDB_SPLACTION_DOES_NOT_START_WITH = 0x03000004,
-    /* Note: Not available in iTunes 4.5 (seems to work on iPod) */
     ITDB_SPLACTION_DOES_NOT_END_WITH = 0x03000008,
 } ItdbSPLAction;