proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-08 03:15:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix the signature documentation

Browse Source 
The parameters are given by '@param name' and not '@name'.

Signed-off-by: Carlos Martín Nieto <cmn@elego.de>
This commit is contained in:
Carlos Martín Nieto 2011-04-07 13:27:34 +02:00 committed by Vicent Marti
parent 076141a137
commit b5c00c6d41
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/git2/signature.h
View File

@ -41,10 +41,10 @@ GIT_BEGIN_DECL
* Create a new action signature. The signature must be freed * Create a new action signature. The signature must be freed
* manually or using git_signature_free * manually or using git_signature_free
* *
* @name name of the person * @param name name of the person
* @email email of the person * @param mail email of the person
* @time time when the action happened * @param time time when the action happened
* @offset timezone offset in minutes for the time * @param offset timezone offset in minutes for the time
* @return the new sig, NULL on out of memory * @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); 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. * Create a copy of an existing signature.
* *
* All internal strings are also duplicated. * 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 * @return a copy of sig, NULL on out of memory
*/ */
GIT_EXTERN(git_signature *) git_signature_dup(const git_signature *sig); 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 * Free an existing signature
* *
* @sig signature to free * @param sig signature to free
*/ */
GIT_EXTERN(void) git_signature_free(git_signature *sig); GIT_EXTERN(void) git_signature_free(git_signature *sig);