data: Let inarray() support <array> IN <array> checks.

[sysdb.git] / src / include / core / data.h

diff --git a/src/include/core/data.h b/src/include/core/data.h
index c03c0c1b6210b730dc0790693f642d45b4012886..997cf9f0a320c616af5074c86f749a03b1dca8b1 100644 (file)
--- a/src/include/core/data.h
+++ b/src/include/core/data.h
@@ -168,7 +168,10 @@ sdb_data_isnull(const sdb_data_t *datum);
  * sdb_data_inarray:
  * Determine whether a datum is included in an array based on the usual
  * comparison function of the value's type. The element type of the array has
- * to match the type of the value.
+ * to match the type of the value. The value may be another array. In that
+ * case, the element types have to match and the function returns true if all
+ * elements of the first array are included in the second where order does not
+ * matter.
  */
 _Bool
 sdb_data_inarray(const sdb_data_t *value, const sdb_data_t *array);