Merge pull request #870 from joshtriplett/fix-note_create-docs

git_note_oid: Fix the documentation to reference parameters using the correct names
This commit is contained in:
Vicent Martí 2012-08-13 21:02:35 -07:00
commit a6ee620185

View File

@ -54,13 +54,13 @@ GIT_EXTERN(const git_oid *) git_note_oid(git_note *note);
/** /**
* Add a note for an object * Add a note for an object
* *
* @param oid pointer to store the OID (optional); NULL in case of error * @param out pointer to store the OID (optional); NULL in case of error
* @param repo the Git repository * @param repo the Git repository
* @param author signature of the notes commit author * @param author signature of the notes commit author
* @param committer signature of the notes commit committer * @param committer signature of the notes commit committer
* @param notes_ref OID reference to update (optional); defaults to "refs/notes/commits" * @param notes_ref OID reference to update (optional); defaults to "refs/notes/commits"
* @param oid The OID of the object * @param oid The OID of the object
* @param oid The note to add for object oid * @param note The note to add for object oid
* *
* @return 0 or an error code * @return 0 or an error code
*/ */