From bfa6cdbf13be242df0cde6cd6e51a005600c0f04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Sat, 6 Dec 2014 03:13:44 +0100 Subject: [PATCH] notes: fix comments for git_note_next() The iterator is the last argument. There is also no returned notes, just ids, so the comment about freeing is out of place. --- include/git2/notes.h | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/include/git2/notes.h b/include/git2/notes.h index 65ce5480b..bb7c02dda 100644 --- a/include/git2/notes.h +++ b/include/git2/notes.h @@ -59,14 +59,12 @@ GIT_EXTERN(int) git_note_iterator_new( 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 * - * 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 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 * (negative value)