Adding comment documentation for rev-parse api.

1 files changed, 17 insertions, 3 deletions

diff --git a/include/git2/revparse.h b/include/git2/revparse.h
index 3fd69d91..4567027e 100644
--- a/include/git2/revparse.h
+++ b/include/git2/revparse.h
@@ -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