diff options
Diffstat (limited to 'include/git2/notes.h')
-rw-r--r-- | include/git2/notes.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/git2/notes.h b/include/git2/notes.h index be69c26ec..7382904ad 100644 --- a/include/git2/notes.h +++ b/include/git2/notes.h @@ -59,7 +59,8 @@ GIT_EXTERN(int) git_note_iterator_new( GIT_EXTERN(void) git_note_iterator_free(git_note_iterator *it); /** - * Next iteration step for note iteration + * Returns 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. * @@ -67,7 +68,8 @@ GIT_EXTERN(void) git_note_iterator_free(git_note_iterator *it); * @param note_id id of blob containing the message * @param annotated_id id of the git object being annotated * - * @return 0, GIT_ITEROVER or an error code + * @return 0 (no error), GIT_ITEROVER (iteration is done) or an error code + * (negative value) */ GIT_EXTERN(int) git_note_next( git_oid* note_id, |