diff options
author | Andreas Linde <mail@andreaslinde.de> | 2013-06-24 15:33:41 +0200 |
---|---|---|
committer | Andreas Linde <mail@andreaslinde.de> | 2013-06-24 15:33:41 +0200 |
commit | e1967164574816b8bf6740ea17d08eeb26c091d2 (patch) | |
tree | b074641f5a6680946c5e861ac630b3a5c41a1ee0 /include/git2/config.h | |
parent | 9f1b2c5cb79526f274c0c72eed56f9da0efb0321 (diff) | |
download | libgit2-e1967164574816b8bf6740ea17d08eeb26c091d2.tar.gz |
Fixed most documentation header bugs
Fixed a few header @param and @return typos with the help of -Wdocumentation in Xcode.
The following warnings have not been fixed:
common.h:213 - Not sure how the documentation format is for '...'
notes.h:102 - Correct @param name but empty text
notes.h:111 - Correct @param name but empty text
pack.h:140 - @return missing text
pack.h:148 - @return missing text
Diffstat (limited to 'include/git2/config.h')
-rw-r--r-- | include/git2/config.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/config.h b/include/git2/config.h index 59b4307be..827d43544 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -119,7 +119,7 @@ GIT_EXTERN(int) git_config_find_xdg(char *out, size_t length); * If /etc/gitconfig doesn't exist, it will look for * %PROGRAMFILES%\Git\etc\gitconfig. - * @param global_config_path Buffer to store the path in + * @param out Buffer to store the path in * @param length size of the buffer in bytes * @return 0 if a system configuration file has been * found. Its path will be stored in `buffer`. @@ -335,8 +335,8 @@ GIT_EXTERN(int) git_config_get_string(const char **out, const git_config *cfg, c * @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 + * @param callback the function to be called on each value of the variable + * @param payload opaque pointer to pass to the callback */ GIT_EXTERN(int) git_config_get_multivar(const git_config *cfg, const char *name, const char *regexp, git_config_foreach_cb callback, void *payload); |