summaryrefslogtreecommitdiff
path: root/include/git2/oid.h
diff options
context:
space:
mode:
authorAndreas Linde <mail@andreaslinde.de>2013-06-24 15:33:41 +0200
committerAndreas Linde <mail@andreaslinde.de>2013-06-24 15:33:41 +0200
commite1967164574816b8bf6740ea17d08eeb26c091d2 (patch)
treeb074641f5a6680946c5e861ac630b3a5c41a1ee0 /include/git2/oid.h
parent9f1b2c5cb79526f274c0c72eed56f9da0efb0321 (diff)
downloadlibgit2-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/oid.h')
-rw-r--r--include/git2/oid.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/oid.h b/include/git2/oid.h
index 018cead4a..662338d93 100644
--- a/include/git2/oid.h
+++ b/include/git2/oid.h
@@ -85,7 +85,7 @@ GIT_EXTERN(void) git_oid_fromraw(git_oid *out, const unsigned char *raw);
* needed for an oid encoded in hex (40 bytes). Only the
* oid digits are written; a '\\0' terminator must be added
* by the caller if it is required.
- * @param oid oid structure to format.
+ * @param id oid structure to format.
*/
GIT_EXTERN(void) git_oid_fmt(char *out, const git_oid *id);
@@ -96,7 +96,7 @@ GIT_EXTERN(void) git_oid_fmt(char *out, const git_oid *id);
* If the number of bytes is > GIT_OID_HEXSZ, extra bytes
* will be zeroed; if not, a '\0' terminator is NOT added.
* @param n number of characters to write into out string
- * @param oid oid structure to format.
+ * @param id oid structure to format.
*/
GIT_EXTERN(void) git_oid_nfmt(char *out, size_t n, const git_oid *id);
@@ -118,7 +118,7 @@ GIT_EXTERN(void) git_oid_pathfmt(char *out, const git_oid *id);
/**
* Format a git_oid into a newly allocated c-string.
*
- * @param oid the oid structure to format
+ * @param id the oid structure to format
* @return the c-string; NULL if memory is exhausted. Caller must
* deallocate the string with git__free().
*/