Skip to content

Commit

Permalink
doc: Document that lists in parser must be NULL terminated
Browse files Browse the repository at this point in the history
Created by @marisn
  • Loading branch information
marisn committed Jul 1, 2023
1 parent f547643 commit a64a2da
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions lib/gis/parser_dependencies.c
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ static void append_error(const char *msg)
When running the module, at most one option from a set can be
provided.
The last item of the list must be NULL.
\param first first given option
*/
void G_option_exclusive(void *first, ...)
Expand All @@ -233,6 +235,8 @@ static void check_exclusive(const struct rule *rule)
At least one option from a set must be given.
The last item of the list must be NULL.
\param first first given option
*/
void G_option_required(void *first, ...)
Expand Down Expand Up @@ -262,6 +266,8 @@ static void check_required(const struct rule *rule)
If the first option is present, at least one of the other
options must also be present.
The last item of the list must be NULL.
If you want all options to be provided use G_option_requires_all()
function.
If you want more than one option to be present but not all,
Expand Down Expand Up @@ -300,6 +306,8 @@ static void check_requires(const struct rule *rule)
If the first option is present, all the other options must also
be present.
The last item of the list must be NULL.
If it is enough if only one option from a set is present,
use G_option_requires() function.
Expand Down Expand Up @@ -334,6 +342,8 @@ static void check_requires_all(const struct rule *rule)
If the first option is present, none of the other options may also (should?)
be present.
The last item of the list must be NULL.
\param first first given option
*/
void G_option_excludes(void *first, ...)
Expand Down Expand Up @@ -363,6 +373,8 @@ static void check_excludes(const struct rule *rule)
If any option is present, all the other options must also be present
all or nothing from a set.
The last item of the list must be NULL.
\param first first given option
*/
void G_option_collective(void *first, ...)
Expand Down

0 comments on commit a64a2da

Please sign in to comment.