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/remote.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/remote.h')
| -rw-r--r-- | include/git2/remote.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h index 3f43916b5..45d15d0a3 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -259,7 +259,7 @@ GIT_EXTERN(int) git_remote_ls(git_remote *remote, git_headlist_cb list_cb, void * @param progress_cb function to call with progress information. Be aware that * this is called inline with network and indexing operations, so performance * may be affected. - * @param progress_payload payload for the progress callback + * @param payload payload for the progress callback * @return 0 or an error code */ GIT_EXTERN(int) git_remote_download( @@ -320,7 +320,7 @@ GIT_EXTERN(int) git_remote_update_tips(git_remote *remote); * Return whether a string is a valid remote URL * * @param url the url to check - * @param 1 if the url is valid, 0 otherwise + * @return 1 if the url is valid, 0 otherwise */ GIT_EXTERN(int) git_remote_valid_url(const char *url); |