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/attr.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/attr.h')
-rw-r--r-- | include/git2/attr.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/git2/attr.h b/include/git2/attr.h index 0d8a910f2..f256ff861 100644 --- a/include/git2/attr.h +++ b/include/git2/attr.h @@ -162,7 +162,7 @@ GIT_EXTERN(int) git_attr_get( * Then you could loop through the 3 values to get the settings for * the three attributes you asked about. * - * @param values An array of num_attr entries that will have string + * @param values_out An array of num_attr entries that will have string * pointers written into it for the values of the attributes. * You should not modify or free the values that are written * into this array (although of course, you should free the |