From 7ea12a8517262bc1edcf7d2d91694ce4407766c3 Mon Sep 17 00:00:00 2001 From: Will Xyen Date: Sun, 1 Dec 2019 15:14:04 -0500 Subject: [PATCH] cconfig: add some documentation to init functions --- src/main/cconfig/cconfig-hook.h | 6 ++++++ src/main/cconfig/cconfig-main.h | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/src/main/cconfig/cconfig-hook.h b/src/main/cconfig/cconfig-hook.h index f765ef3..92f369e 100644 --- a/src/main/cconfig/cconfig-hook.h +++ b/src/main/cconfig/cconfig-hook.h @@ -4,6 +4,12 @@ #include "cconfig/cconfig.h" #include "cconfig/cmd.h" +/** + * Init function for cconfig for hooks + * + * calls cconfig_main_config_init with some defaults for hook dlls + * see: cconfig_main_config_init for more details + */ bool cconfig_hook_config_init( struct cconfig *config, const char *usage_header, diff --git a/src/main/cconfig/cconfig-main.h b/src/main/cconfig/cconfig-main.h index 5b172c9..a062c61 100644 --- a/src/main/cconfig/cconfig-main.h +++ b/src/main/cconfig/cconfig-main.h @@ -4,6 +4,12 @@ #include "cconfig/cconfig.h" #include "cconfig/cmd.h" +/** + * Init function for cconfig after all cconfig_util_set's have been called + * + * will parse a config file first (if specified) + * then uses override config parameters from cmd + */ bool cconfig_main_config_init( struct cconfig *config, const char *config_cmd_param_name,