util/env: add docs

I always forget what env_parse_switch() does on error.

1 files changed, 12 insertions, 0 deletions

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 <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