Fix documentation of git_branch_delete.

The reference should be freed by the user, not the library.
This commit is contained in:
Daniel Rodríguez Troitiño 2013-05-26 17:29:00 +02:00
parent 0d77647adc
commit f8bd730cd9

View File

@ -58,7 +58,8 @@ GIT_EXTERN(int) git_branch_create(
* Delete an existing branch reference. * Delete an existing branch reference.
* *
* If the branch is successfully deleted, the passed reference * If the branch is successfully deleted, the passed reference
* object will be freed and invalidated. * object will be invalidated. The reference must be freed manually
* by the user.
* *
* @param branch A valid reference representing a branch * @param branch A valid reference representing a branch
* @return 0 on success, or an error code. * @return 0 on success, or an error code.