mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-03 07:44:49 +00:00
Adding comment documentation for rev-parse api.
This commit is contained in:
parent
38533d5acf
commit
bfc13e7985
@ -11,12 +11,26 @@
|
|||||||
#include "types.h"
|
#include "types.h"
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file git2/revparse.h
|
||||||
|
* @brief Git revision parsing routines
|
||||||
|
* @defgroup git_revparse Git revision parsing routines
|
||||||
|
* @ingroup Git
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
GIT_BEGIN_DECL
|
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_single(git_object **out, git_repository *repo, const char *spec);
|
||||||
|
|
||||||
//GIT_EXTERN(int) git_revparse_multi(TODO);
|
/** @} */
|
||||||
|
|
||||||
GIT_END_DECL
|
GIT_END_DECL
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
Loading…
Reference in New Issue
Block a user