util/env: add docs

I always forget what env_parse_switch() does on error.
This commit is contained in:
Simon Ser 2022-12-06 11:42:03 +01:00
parent 1bd0ba3949
commit dc09585d14

View file

@ -4,8 +4,20 @@
#include <stdbool.h>
#include <unistd.h>
/**
* Parse a bool from an environment variable.
*
* On success, the parsed value is returned. On error, false is returned.
*/
bool env_parse_bool(const char *option);
/**
* Pick a choice from an environment variable.
*
* On success, the choice index is returned. On error, zero is returned.
*
* switches is a NULL-terminated array.
*/
ssize_t env_parse_switch(const char *option, const char **switches);
#endif