- * 1 : s = string to split
- * 2 : c = array of delimiters
- * 3 : v[] = results vector (aka. array)
- * 4 : n = number of usable slots in the vector (aka. array size)
- * 5 : m = consecutive delimiters means multiple fields?
- * 6 : l = ignore leading field separators?
- *
- * Returns : -1 => failure, else the number of fields put in `v'.
+ * 1 : str = string to split. Will be split in place
+ * (i.e. do not free until you've finished with vec,
+ * previous contents will be trashed by the call).
+ * 2 : delim = array of delimiters (if NULL, uses " \t").
+ * 3 : vec[] = results vector (aka. array) [out]
+ * 4 : vec_len = number of usable slots in the vector (aka. array size)
+ * 5 : dont_save_empty_fields = zero if consecutive delimiters
+ * give a null output field(s), nonzero if they are just
+ * to be considered as single delimeter
+ * 6 : ignore_leading = nonzero to ignore leading field
+ * separators.
+ *
+ * Returns : -1 => Error: vec_len is too small to hold all the
+ * data, or str == NULL.
+ * >=0 => the number of fields put in `vec'.
+ * On error, vec and str may still have been overwritten.