Reword a comment in wordsplit.h

This commit is contained in:
Sergey Poznyakoff 2018-06-04 11:11:20 +03:00
parent 8923c8c06f
commit 384c7f6fcb

View file

@ -26,9 +26,11 @@ typedef struct wordsplit wordsplit_t;
provide return values when the function returns. If neither mark is
used, the member is internal and must not be used by the caller.
In the comments below, the
identifiers in parentheses indicate bits that must be set (or unset, if
starting with !) in the ws_flags to initialize or use the given member.
In the comments below, the identifiers in parentheses indicate bits that
must be set (or unset, if starting with !) in ws_flags (if starting with
WRDSF_) or ws_options (if starting with WRDSO_) to initialize or use the
given member.
If not redefined explicitly, most of them are set to some reasonable
default value upon entry to wordsplit(). */
struct wordsplit