cconfig: add some documentation to init functions

This commit is contained in:
Will Xyen
2019-12-01 15:14:04 -05:00
parent 82ac30e49f
commit 7ea12a8517
2 changed files with 12 additions and 0 deletions

View File

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

View File

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