diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2014-12-06 03:13:44 +0100 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-12-06 04:20:10 +0100 |
| commit | bfa6cdbf13be242df0cde6cd6e51a005600c0f04 (patch) | |
| tree | 7cb19a94a388cf1ace6df5a77a7ada75d39d77f7 /include/git2/notes.h | |
| parent | 21083a712933248ecc71a09abd20d548b912b194 (diff) | |
| download | libgit2-bfa6cdbf13be242df0cde6cd6e51a005600c0f04.tar.gz | |
notes: fix comments for git_note_next()cmn/notes-consistency
The iterator is the last argument. There is also no returned notes, just
ids, so the comment about freeing is out of place.
Diffstat (limited to 'include/git2/notes.h')
| -rw-r--r-- | include/git2/notes.h | 6 |
1 files 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) |