From d9da4ccaa05628bf0b52bac8780d209eb96f7635 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Sun, 5 Feb 2012 18:08:23 +0100 Subject: [PATCH] Document {get,set}_multivar --- include/git2/config.h | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/include/git2/config.h b/include/git2/config.h index 82d9de870..8a0f58937 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);