argpar_iter_parse_next(): make the `error` parameter optional

[argpar.git] / argpar / argpar.h

diff --git a/argpar/argpar.h b/argpar/argpar.h
index 1187def7ccdf8021bf6948165a936117bdc8f21a..c6f79cf64f6e5ad445464ab7dd1cb02b5c52d9d4 100644 (file)
--- a/argpar/argpar.h
+++ b/argpar/argpar.h
@@ -323,8 +323,9 @@ enum argpar_iter_parse_next_status {
  *
  * On failure (status codes
  * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT` and
  *
  * On failure (status codes
  * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR_UNKNOWN_OPT` and

- * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR`), this function sets `*error`
- * to a descriptive error string. Free `*error` with free().
+ * `ARGPAR_ITER_PARSE_NEXT_STATUS_ERROR`), this function sets `*error`,
+ * if not `NULL`, to a descriptive error string. Free `*error` with
+ * free().

  *
  * Create an argument parsing iterator with argpar_iter_create().
  */
  *
  * Create an argument parsing iterator with argpar_iter_create().
  */