Commit b5c00c6d41ff4eb809f7deda38fe61ccaacb7cbf
2011-04-07T13:27:34
Fix the signature documentation The parameters are given by '@param name' and not '@name'. Signed-off-by: Carlos Martín Nieto <cmn@elego.de>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
diff --git a/include/git2/signature.h b/include/git2/signature.h
index 40412a4..b0995c8 100644
--- a/include/git2/signature.h
+++ b/include/git2/signature.h
@@ -41,10 +41,10 @@ GIT_BEGIN_DECL
* Create a new action signature. The signature must be freed
* manually or using git_signature_free
*
- * @name name of the person
- * @email email of the person
- * @time time when the action happened
- * @offset timezone offset in minutes for the time
+ * @param name name of the person
+ * @param mail email of the person
+ * @param time time when the action happened
+ * @param offset timezone offset in minutes for the time
* @return the new sig, NULL on out of memory
*/
GIT_EXTERN(git_signature *) git_signature_new(const char *name, const char *email, git_time_t time, int offset);
@@ -53,7 +53,7 @@ GIT_EXTERN(git_signature *) git_signature_new(const char *name, const char *emai
* Create a copy of an existing signature.
*
* All internal strings are also duplicated.
- * @sig signature to duplicated
+ * @param sig signature to duplicated
* @return a copy of sig, NULL on out of memory
*/
GIT_EXTERN(git_signature *) git_signature_dup(const git_signature *sig);
@@ -61,7 +61,7 @@ GIT_EXTERN(git_signature *) git_signature_dup(const git_signature *sig);
/**
* Free an existing signature
*
- * @sig signature to free
+ * @param sig signature to free
*/
GIT_EXTERN(void) git_signature_free(git_signature *sig);