From dc09585d14b53f186d4be78126824faf27da55b8 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Tue, 6 Dec 2022 11:42:03 +0100 Subject: [PATCH] util/env: add docs I always forget what env_parse_switch() does on error. --- include/util/env.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/include/util/env.h b/include/util/env.h index 6720fa89..1edae0dd 100644 --- a/include/util/env.h +++ b/include/util/env.h @@ -4,8 +4,20 @@ #include #include +/** + * 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