diff options
author | Carlos Martín Nieto <carlos@cmartin.tk> | 2012-02-05 18:08:23 +0100 |
---|---|---|
committer | Carlos Martín Nieto <carlos@cmartin.tk> | 2012-02-17 19:50:30 +0100 |
commit | d9da4ccaa05628bf0b52bac8780d209eb96f7635 (patch) | |
tree | ceec5bcd962389e5bea9781062024d79e61b1bb7 /include/git2/config.h | |
parent | 3005855f7e3980185adc63a68c5b8b5f9e3b506f (diff) | |
download | libgit2-d9da4ccaa05628bf0b52bac8780d209eb96f7635.tar.gz |
Document {get,set}_multivar
Diffstat (limited to 'include/git2/config.h')
-rw-r--r-- | include/git2/config.h | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/include/git2/config.h b/include/git2/config.h index 82d9de87..8a0f5893 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -208,8 +208,16 @@ GIT_EXTERN(int) git_config_get_bool(git_config *cfg, const char *name, int *out) GIT_EXTERN(int) git_config_get_string(git_config *cfg, const char *name, const char **out); /** - * Get each value of a multivar. The callback will be called on each - * variable found + * Get each value of a multivar. + * + * The callback will be called on each variable found + * + * @param cfg where to look for the variable + * @param name the variable's name + * @param regexp regular expression to filter which variables we're + * interested in. Use NULL to indicate all + * @param fn the function to be called on each value of the variable + * @param data opaque pointer to pass to the callback */ GIT_EXTERN(int) git_config_get_multivar(git_config *cfg, const char *name, const char *regexp, int (*fn)(const char *, void *), void *data); @@ -259,6 +267,11 @@ GIT_EXTERN(int) git_config_set_string(git_config *cfg, const char *name, const c /** * Set a multivar + * + * @param cfg where to look for the variable + * @param name the variable's name + * @param regexp a regular expression to indicate which values to replace + * @param value the new value. */ GIT_EXTERN(int) git_config_set_multivar(git_config *cfg, const char *name, const char *regexp, const char *value); |