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

notes: fix comments for git_note_next()

Browse Source 
The iterator is the last argument. There is also no returned notes, just
ids, so the comment about freeing is out of place.
This commit is contained in:
Carlos Martín Nieto 2014-12-06 03:13:44 +01:00
parent 21083a7129
commit bfa6cdbf13
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/git2/notes.h
View File

@ -59,14 +59,12 @@ GIT_EXTERN(int) git_note_iterator_new(
GIT_EXTERN(void) git_note_iterator_free(git_note_iterator *it); GIT_EXTERN(void) git_note_iterator_free(git_note_iterator *it);
/** /**
* Returns the current item (note_id and annotated_id) and advance the iterator * Return the current item (note_id and annotated_id) and advance the iterator
* internally to the next value * internally to the next value
* *
* The notes must not be freed manually by the user.
*
* @param it pointer to the iterator
* @param note_id id of blob containing the message * @param note_id id of blob containing the message
* @param annotated_id id of the git object being annotated * @param annotated_id id of the git object being annotated
* @param it pointer to the iterator
* *
* @return 0 (no error), GIT_ITEROVER (iteration is done) or an error code * @return 0 (no error), GIT_ITEROVER (iteration is done) or an error code
* (negative value) * (negative value)