From 18079e234a9fb8ee3ee8686cf3e28d5920326a4a Mon Sep 17 00:00:00 2001 From: Tony Crisci Date: Sat, 11 Nov 2017 10:44:29 -0500 Subject: [PATCH] rootston: documentation for config.h functions --- include/rootston/config.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/rootston/config.h b/include/rootston/config.h index 8ef58100..d2a25b5b 100644 --- a/include/rootston/config.h +++ b/include/rootston/config.h @@ -58,8 +58,16 @@ struct roots_config { char *startup_cmd; }; +/** + * Create a roots config from the given command line arguments. Command line + * arguments can specify the location of the config file. If it is not + * specified, the default location will be used. + */ struct roots_config *parse_args(int argc, char *argv[]); +/** + * Destroy the config and free its resources. + */ void roots_config_destroy(struct roots_config *config); /**