proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-02 17:42:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adding comment documentation for rev-parse api.

Browse Source
This commit is contained in:
Ben Straub 2012-04-30 09:58:43 -07:00
parent 38533d5acf
commit bfc13e7985
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/git2/revparse.h
View File

@ -11,12 +11,26 @@
#include "types.h"
/**
* @file git2/revparse.h
* @brief Git revision parsing routines
* @defgroup git_revparse Git revision parsing routines
* @ingroup Git
* @{
*/
GIT_BEGIN_DECL
/**
* Find an object, as specified by a revision string. See `man gitrevisions`, or the documentation
* for `git rev-parse` for information on the syntax accepted.
*
* @param out pointer to output object
* @param repo the repository to search in
* @param spec the textual specification for an object
* @return on success, GIT_ERROR otherwise (use git_error_last for information about the error)
*/
GIT_EXTERN(int) git_revparse_single(git_object **out, git_repository *repo, const char *spec);
//GIT_EXTERN(int) git_revparse_multi(TODO);
/** @} */
GIT_END_DECL
#endif