Commit f44cbec4799538b201c5e14419fac9cc1544882e

Carlos Martín Nieto 2011-05-17T14:59:23

Add documentation for git_config_add_backend

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
diff --git a/include/git2/config.h b/include/git2/config.h
index 4e10a5c..9ae54f1 100644
--- a/include/git2/config.h
+++ b/include/git2/config.h
@@ -58,7 +58,14 @@ GIT_EXTERN(int) git_config_open_bare(git_config **cfg_out, const char *path);
 GIT_EXTERN(int) git_config_open_global(git_config **cfg);
 
 /**
+ * Add a config backend to an existing instance
  *
+ * Note that the configuration will call the backend's ->free()
+ * function.
+ *
+ * @param cfg the configuration to add the backend to
+ * @param backend the backend to add
+ * @param priority the priority the backend should have
  */
 GIT_EXTERN(int) git_config_add_backend(git_config *cfg, git_config_backend *backend, int priority);