]> git.proxmox.com Git - libgit2.git/commitdiff
index.h: Correct documentation for git_index_open_inrepo()
authorJakob Pfender <jpfender@elegosoft.com>
Thu, 24 Mar 2011 12:48:22 +0000 (13:48 +0100)
committerVicent Marti <tanoku@gmail.com>
Thu, 24 Mar 2011 22:49:47 +0000 (00:49 +0200)
Fix the doxygen comments for git_index_open_inrepo(). Previously they
referred to a param index_path and omitted index (probably a c&p
error).

include/git2/index.h

index 605740c10305a27186278e37f4c6347f665b77b8..7bb0c95293e4292090319c4d4eee1e21c7131127 100644 (file)
@@ -91,8 +91,8 @@ GIT_EXTERN(int) git_index_open_bare(git_index **index, const char *index_path);
  * Open the Index inside the git repository pointed
  * by 'repo'.
  *
+ * @param index the pointer for the new index
  * @param repo the git repo which owns the index
- * @param index_path the path to the index file in disk
  * @return 0 on success; error code otherwise
  */
 GIT_EXTERN(int) git_index_open_inrepo(git_index **index, git_repository *repo);