Idea-Studios/libgit2
2
0
Fork 0
mirror of https://github.com/libgit2/libgit2.git synced 2026-06-22 06:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: specify out params

Browse Source
This commit is contained in:
Edward Thomson
2026-06-13 17:01:04 +01:00
parent 44c05e5d12
commit da0d84625d
47 changed files with 396 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/git2/commit.h
View File

@@ -182,13 +182,15 @@ GIT_EXTERN(const git_signature *) git_commit_author(const git_commit *commit);
*
* Call `git_signature_free` to free the signature.
*
* @param out a pointer to store the resolved signature.
* @param[out] out a pointer to store the resolved signature.
* @param commit a previously loaded commit.
* @param mailmap the mailmap to resolve with. (may be NULL)
* @return 0 or an error code
*/
GIT_EXTERN(int) git_commit_committer_with_mailmap(
git_signature **out, const git_commit *commit, const git_mailmap *mailmap);
git_signature **out,
const git_commit *commit,
const git_mailmap *mailmap);
/**
* Get the author of a commit, using the mailmap to map names and email
@@ -196,13 +198,15 @@ GIT_EXTERN(int) git_commit_committer_with_mailmap(
*
* Call `git_signature_free` to free the signature.
*
* @param out a pointer to store the resolved signature.
* @param[out] out a pointer to store the resolved signature.
* @param commit a previously loaded commit.
* @param mailmap the mailmap to resolve with. (may be NULL)
* @return 0 or an error code
*/
GIT_EXTERN(int) git_commit_author_with_mailmap(
git_signature **out, const git_commit *commit, const git_mailmap *mailmap);
git_signature **out,
const git_commit *commit,
const git_mailmap *mailmap);
/**
* Get the full raw text of the commit header.
@@ -242,7 +246,7 @@ GIT_EXTERN(unsigned int) git_commit_parentcount(const git_commit *commit);
/**
* Get the specified parent of the commit.
*
* @param out Pointer where to store the parent commit
* @param[out] out Pointer where to store the parent commit
* @param commit a previously loaded commit.
* @param n the position of the parent (from 0 to `parentcount`)
* @return 0 or an error code
@@ -791,7 +795,7 @@ GIT_EXTERN(int) git_commit_create_with_signature(
* Create an in-memory copy of a commit. The copy must be explicitly
* free'd or it will leak.
*
* @param out Pointer to store the copy of the commit
* @param[out] out Pointer to store the copy of the commit
* @param source Original commit to copy
* @return 0
*/