diff options
| author | Nico von Geyso <Nico.Geyso@FU-Berlin.de> | 2013-03-06 22:25:01 +0100 |
|---|---|---|
| committer | Nico von Geyso <Nico.Geyso@FU-Berlin.de> | 2013-03-06 22:36:19 +0100 |
| commit | f7b18502154edac242ab3760feb05600e09d67b3 (patch) | |
| tree | af284a120d670cd4563830fc92329334527240a8 /include/git2/notes.h | |
| parent | 1a90dcf64e561b21e0981a7d87d71e349fa37f69 (diff) | |
| download | libgit2-f7b18502154edac242ab3760feb05600e09d67b3.tar.gz | |
fixed minor issues with new note iterator
* fixed style issues
* use new iterator functions for git_note_foreach()
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, |