proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-06-19 20:36:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Various minor commenting fixes

Browse Source
This commit is contained in:
Russell Belfer 2012-11-27 15:28:48 -08:00
parent c3fb7d04ed
commit ca94e031fa
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/git2/repository.h
View File

@ -238,7 +238,7 @@ typedef enum {
* repository initialization is completed, an "origin" remote * repository initialization is completed, an "origin" remote
* will be added pointing to this URL. * will be added pointing to this URL.
*/ */
typedef struct git_repository_init_options { typedef struct {
uint32_t flags; uint32_t flags;
uint32_t mode; uint32_t mode;
const char *workdir_path; const char *workdir_path;
@ -269,6 +269,10 @@ GIT_EXTERN(int) git_repository_init_ext(
/** /**
* Retrieve and resolve the reference pointed at by HEAD. * Retrieve and resolve the reference pointed at by HEAD.
* *
* The returned `git_reference` will be owned by caller and
* `git_reference_free()` must be called when done with it to release the
* allocated memory and prevent a leak.
*
* @param out pointer to the reference which will be retrieved * @param out pointer to the reference which will be retrieved
* @param repo a repository object * @param repo a repository object
* *

23
include/git2/signature.h
View File

@ -20,8 +20,9 @@
GIT_BEGIN_DECL GIT_BEGIN_DECL
/** /**
* Create a new action signature. The signature must be freed * Create a new action signature.
* manually or using git_signature_free *
* Call `git_signature_free()` to free the data.
* *
* Note: angle brackets ('<' and '>') characters are not allowed * Note: angle brackets ('<' and '>') characters are not allowed
* to be used in either the `name` or the `email` parameter. * to be used in either the `name` or the `email` parameter.
@ -36,8 +37,9 @@ GIT_BEGIN_DECL
GIT_EXTERN(int) git_signature_new(git_signature **out, const char *name, const char *email, git_time_t time, int offset); GIT_EXTERN(int) git_signature_new(git_signature **out, const char *name, const char *email, git_time_t time, int offset);
/** /**
* Create a new action signature with a timestamp of 'now'. The * Create a new action signature with a timestamp of 'now'.
* signature must be freed manually or using git_signature_free *
* Call `git_signature_free()` to free the data.
* *
* @param out new signature, in case of error NULL * @param out new signature, in case of error NULL
* @param name name of the person * @param name name of the person
@ -48,9 +50,10 @@ GIT_EXTERN(int) git_signature_now(git_signature **out, const char *name, const c
/** /**
* Create a copy of an existing signature. All internal strings are also duplicated. * Create a copy of an existing signature. All internal strings are also
* The caller is responsible for freeing this structure with * duplicated.
* git_signature_free. *
* Call `git_signature_free()` to free the data.
* *
* @param 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
@ -58,7 +61,11 @@ GIT_EXTERN(int) git_signature_now(git_signature **out, const char *name, const c
GIT_EXTERN(git_signature *) git_signature_dup(const git_signature *sig); GIT_EXTERN(git_signature *) git_signature_dup(const git_signature *sig);
/** /**
* Free an existing signature * Free an existing signature.
*
* Because the signature is not an opaque structure, it is legal to free it
* manually, but be sure to free the "name" and "email" strings in addition
* to the structure itself.
* *
* @param sig signature to free * @param sig signature to free
*/ */