diff options
| author | Etienne Samson <samson.etienne@gmail.com> | 2019-06-19 19:46:12 +0200 |
|---|---|---|
| committer | Etienne Samson <samson.etienne@gmail.com> | 2019-06-26 15:49:37 +0200 |
| commit | 33448b4519a83836d876556f46a0b7f9f5c90995 (patch) | |
| tree | d93627e3fc2f236f24776ad86c6accf343e85a2e /include/git2/sys | |
| parent | c544850127abb96b472485768dee3ede68e1622e (diff) | |
| download | libgit2-33448b4519a83836d876556f46a0b7f9f5c90995.tar.gz | |
docs: More of it
Diffstat (limited to 'include/git2/sys')
| -rw-r--r-- | include/git2/sys/alloc.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/include/git2/sys/alloc.h b/include/git2/sys/alloc.h index 642740dab..c295807bc 100644 --- a/include/git2/sys/alloc.h +++ b/include/git2/sys/alloc.h @@ -21,51 +21,51 @@ GIT_BEGIN_DECL * that all fields need to be set to a proper function. */ typedef struct { - /* Allocate `n` bytes of memory */ + /** Allocate `n` bytes of memory */ void * GIT_CALLBACK(gmalloc)(size_t n, const char *file, int line); - /* + /** * Allocate memory for an array of `nelem` elements, where each element * has a size of `elsize`. Returned memory shall be initialized to * all-zeroes */ void * GIT_CALLBACK(gcalloc)(size_t nelem, size_t elsize, const char *file, int line); - /* Allocate memory for the string `str` and duplicate its contents. */ + /** Allocate memory for the string `str` and duplicate its contents. */ char * GIT_CALLBACK(gstrdup)(const char *str, const char *file, int line); - /* + /** * Equivalent to the `gstrdup` function, but only duplicating at most * `n + 1` bytes */ char * GIT_CALLBACK(gstrndup)(const char *str, size_t n, const char *file, int line); - /* + /** * Equivalent to `gstrndup`, but will always duplicate exactly `n` bytes * of `str`. Thus, out of bounds reads at `str` may happen. */ char * GIT_CALLBACK(gsubstrdup)(const char *str, size_t n, const char *file, int line); - /* + /** * This function shall deallocate the old object `ptr` and return a * pointer to a new object that has the size specified by `size`. In * case `ptr` is `NULL`, a new array shall be allocated. */ void * GIT_CALLBACK(grealloc)(void *ptr, size_t size, const char *file, int line); - /* + /** * This function shall be equivalent to `grealloc`, but allocating * `neleme * elsize` bytes. */ void * GIT_CALLBACK(greallocarray)(void *ptr, size_t nelem, size_t elsize, const char *file, int line); - /* + /** * This function shall allocate a new array of `nelem` elements, where * each element has a size of `elsize` bytes. */ void * GIT_CALLBACK(gmallocarray)(size_t nelem, size_t elsize, const char *file, int line); - /* + /** * This function shall free the memory pointed to by `ptr`. In case * `ptr` is `NULL`, this shall be a no-op. */ |
