cmdine:: allow non-final completion (will be used by file token)
[libcmdline.git] / src / lib / cmdline_parse.h
index 6facb9e..9196cc7 100644 (file)
@@ -101,7 +101,8 @@ typedef struct cmdline_token_hdr cmdline_parse_token_hdr_t;
  *
  * complete_iterate() copy in dstbuf (the size is specified in the
  * parameter) the next possible completion for this token. Return 0 on
- * success or a negative value on error (or when there is no more
+ * success (final completion), 1 if it's an intermediate completion,
+ * or a negative value on error (or when there is no more
  * completion). Refer to cmdline_complete_string_iterate() for an
  * example.
  *