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/errors.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/errors.h')
| -rw-r--r-- | include/git2/errors.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/git2/errors.h b/include/git2/errors.h index caf9e62b8..2032a436a 100644 --- a/include/git2/errors.h +++ b/include/git2/errors.h @@ -100,7 +100,7 @@ GIT_EXTERN(void) giterr_clear(void); * * @param error_class One of the `git_error_t` enum above describing the * general subsystem that is responsible for the error. - * @param message The formatted error message to keep + * @param string The formatted error message to keep */ GIT_EXTERN(void) giterr_set_str(int error_class, const char *string); |