Commit bfa6cdbf by Carlos Martín Nieto

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.
parent 21083a71
...@@ -59,14 +59,12 @@ GIT_EXTERN(int) git_note_iterator_new( ...@@ -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)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment